Cisco-IOS-XR-ipv4-dhcpd-cfg API API Reference
API generated from Cisco-IOS-XR-ipv4-dhcpd-cfg@2017-09-30.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key Mandatory OptionalPaths
IPV4-DHCPD - Update
Update operation of resource: ipv4-dhcpd
ipv4-dhcpdbody object
Request Content-Types: application/json
Request Example
{
"enable": [ null ],
"outer-cos": "integer", "full-write-interval": "integer",
"incremental-write-interval": "integer",
"proxy": [ null ],
"snoop": [ null ],
"server": [ null ]
}, { "profile-name": "string",
"mode": "string"
},
"interface-name": "string", "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, {
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
]
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string"
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV4-DHCPD - Create
Create operation of resource: ipv4-dhcpd
ipv4-dhcpdbody object
Request Content-Types: application/json
Request Example
{
"enable": [ null ],
"outer-cos": "integer", "full-write-interval": "integer",
"incremental-write-interval": "integer",
"proxy": [ null ],
"snoop": [ null ],
"server": [ null ]
}, { "profile-name": "string",
"mode": "string"
},
"interface-name": "string", "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, {
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
]
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string"
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV4-DHCPD - Delete
Delete operation of resource: ipv4-dhcpd
Successful operation
Internal Error
Response Content-Types: application/json
IPV4-DHCPD - Retrieve
Retrieve operation of resource: ipv4-dhcpd
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ],
"outer-cos": "integer", "full-write-interval": "integer",
"incremental-write-interval": "integer",
"proxy": [ null ],
"snoop": [ null ],
"server": [ null ]
}, { "profile-name": "string",
"mode": "string"
},
"interface-name": "string", "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, {
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
]
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string"
}
}
}
]
}
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of vrf-name
PROFILE - Update
Update operation of resource: profile
profilebody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"profile-name": "string",
"mode": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Create
Create operation of resource: profile
profilebody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"profile-name": "string",
"mode": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Delete
Delete operation of resource: profile
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Retrieve
Retrieve operation of resource: profile
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"profile-name": "string",
"mode": "string"
}
PROFILES - Update
Update operation of resource: profiles
profilesbody object
Request Content-Types: application/json
Request Example
{ { { "proxy-allow-move": [ null ], "limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ], "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ], "arg1": "string",
"arg2": "string"
}, "policy": "string"
}, "set-server-options": [ null ],
"client-lease-time": "integer"
}, {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}, {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ], "policy": "string"
}, "option": [ "integer" ],
"option-all": "integer"
}
}
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, "authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
},
"enable": [ null ], "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ]
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILES - Create
Create operation of resource: profiles
profilesbody object
Request Content-Types: application/json
Request Example
{ { { "proxy-allow-move": [ null ], "limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ], "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ], "arg1": "string",
"arg2": "string"
}, "policy": "string"
}, "set-server-options": [ null ],
"client-lease-time": "integer"
}, {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}, {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ], "policy": "string"
}, "option": [ "integer" ],
"option-all": "integer"
}
}
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, "authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
},
"enable": [ null ], "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ]
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILES - Delete
Delete operation of resource: profiles
Successful operation
Internal Error
Response Content-Types: application/json
PROFILES - Retrieve
Retrieve operation of resource: profiles
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { "proxy-allow-move": [ null ], "limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ], "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ], "arg1": "string",
"arg2": "string"
}, "policy": "string"
}, "set-server-options": [ null ],
"client-lease-time": "integer"
}, {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}, {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ], "policy": "string"
}, "option": [ "integer" ],
"option-all": "integer"
}
}
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, "authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
},
"enable": [ null ], "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ]
}
}
}
]
}
}
]
}
PROFILE - Update
Update operation of resource: profile
profilebody object
ID of profile-name
Request Content-Types: application/json
Request Example
{
"profile-name": "string",
"mode": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Create
Create operation of resource: profile
profilebody object
ID of profile-name
Request Content-Types: application/json
Request Example
{
"profile-name": "string",
"mode": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Delete
Delete operation of resource: profile
ID of profile-name
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Retrieve
Retrieve operation of resource: profile
ID of profile-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"profile-name": "string",
"mode": "string"
}
MODES - Update
Update operation of resource: modes
modesbody object
ID of profile-name
Request Content-Types: application/json
Request Example
{ { "proxy-allow-move": [ null ], "limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ], "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ], "arg1": "string",
"arg2": "string"
}, "policy": "string"
}, "set-server-options": [ null ],
"client-lease-time": "integer"
}, {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}, {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ], "policy": "string"
}, "option": [ "integer" ],
"option-all": "integer"
}
}
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, "authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
},
"enable": [ null ], "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
MODES - Create
Create operation of resource: modes
modesbody object
ID of profile-name
Request Content-Types: application/json
Request Example
{ { "proxy-allow-move": [ null ], "limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ], "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ], "arg1": "string",
"arg2": "string"
}, "policy": "string"
}, "set-server-options": [ null ],
"client-lease-time": "integer"
}, {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}, {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ], "policy": "string"
}, "option": [ "integer" ],
"option-all": "integer"
}
}
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, "authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
},
"enable": [ null ], "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
MODES - Delete
Delete operation of resource: modes
ID of profile-name
Successful operation
Internal Error
Response Content-Types: application/json
MODES - Retrieve
Retrieve operation of resource: modes
ID of profile-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "proxy-allow-move": [ null ], "limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ], "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ], "arg1": "string",
"arg2": "string"
}, "policy": "string"
}, "set-server-options": [ null ],
"client-lease-time": "integer"
}, {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}, {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ], "policy": "string"
}, "option": [ "integer" ],
"option-all": "integer"
}
}
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, "authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
},
"enable": [ null ], "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ]
}
}
}
]
}
MODE - Update
Update operation of resource: mode
modebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "proxy-allow-move": [ null ], "limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ], "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ], "arg1": "string",
"arg2": "string"
}, "policy": "string"
}, "set-server-options": [ null ],
"client-lease-time": "integer"
}, {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}, {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ], "policy": "string"
}, "option": [ "integer" ],
"option-all": "integer"
}
}
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, "authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
},
"enable": [ null ], "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MODE - Create
Create operation of resource: mode
modebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "proxy-allow-move": [ null ], "limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ], "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ], "arg1": "string",
"arg2": "string"
}, "policy": "string"
}, "set-server-options": [ null ],
"client-lease-time": "integer"
}, {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}, {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ], "policy": "string"
}, "option": [ "integer" ],
"option-all": "integer"
}
}
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, "authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
},
"enable": [ null ], "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MODE - Delete
Delete operation of resource: mode
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
MODE - Retrieve
Retrieve operation of resource: mode
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "proxy-allow-move": [ null ], "limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ], "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ], "arg1": "string",
"arg2": "string"
}, "policy": "string"
}, "set-server-options": [ null ],
"client-lease-time": "integer"
}, {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}, {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ], "policy": "string"
}, "option": [ "integer" ],
"option-all": "integer"
}
}
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, "authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
},
"enable": [ null ], "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ]
}
}
}
SNOOP - Update
Update operation of resource: snoop
snoopbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP - Create
Create operation of resource: snoop
snoopbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP - Delete
Delete operation of resource: snoop
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP - Retrieve
Retrieve operation of resource: snoop
ID of profile-name
ID of mode
Successful operation
Internal Error
RELAY-INFORMATION-OPTION - Update
Update operation of resource: relay-information-option
relay-information-optionbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Create
Create operation of resource: relay-information-option
relay-information-optionbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Delete
Delete operation of resource: relay-information-option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Retrieve
Retrieve operation of resource: relay-information-option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
REMOTE-ID - Update
Update operation of resource: remote-id
remote-idbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"format-type": "integer",
"remote-id-value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-ID - Create
Create operation of resource: remote-id
remote-idbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"format-type": "integer",
"remote-id-value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-ID - Delete
Delete operation of resource: remote-id
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-ID - Retrieve
Retrieve operation of resource: remote-id
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"format-type": "integer",
"remote-id-value": "string"
}
BASE - Update
Update operation of resource: base
basebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "profile-name": "string",
"profile-mode": "integer"
}, "authenticate": "integer",
"remote-id": "string"
},
"enable": [ null ], {
"pattern": "string",
"matchoption": "integer",
"option-action": "string",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, {
"opt60": "integer", "profile-name": "string",
"profile-mode": "integer"
},
"opt60-hex-str": "string",
"format": "integer"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE - Create
Create operation of resource: base
basebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "profile-name": "string",
"profile-mode": "integer"
}, "authenticate": "integer",
"remote-id": "string"
},
"enable": [ null ], {
"pattern": "string",
"matchoption": "integer",
"option-action": "string",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, {
"opt60": "integer", "profile-name": "string",
"profile-mode": "integer"
},
"opt60-hex-str": "string",
"format": "integer"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE - Delete
Delete operation of resource: base
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BASE - Retrieve
Retrieve operation of resource: base
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "profile-name": "string",
"profile-mode": "integer"
}, "authenticate": "integer",
"remote-id": "string"
},
"enable": [ null ], {
"pattern": "string",
"matchoption": "integer",
"option-action": "string",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, {
"opt60": "integer", "profile-name": "string",
"profile-mode": "integer"
},
"opt60-hex-str": "string",
"format": "integer"
}
]
}
}
}
DEFAULT-PROFILE - Update
Update operation of resource: default-profile
default-profilebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"profile-name": "string",
"profile-mode": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-PROFILE - Create
Create operation of resource: default-profile
default-profilebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"profile-name": "string",
"profile-mode": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-PROFILE - Delete
Delete operation of resource: default-profile
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-PROFILE - Retrieve
Retrieve operation of resource: default-profile
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"profile-name": "string",
"profile-mode": "integer"
}
MATCH - Update
Update operation of resource: match
matchbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}
OPTION-FILTERS - Update
Update operation of resource: option-filters
option-filtersbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Create
Create operation of resource: option-filters
option-filtersbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Delete
Delete operation of resource: option-filters
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Retrieve
Retrieve operation of resource: option-filters
ID of profile-name
ID of mode
Successful operation
Internal Error
OPTION-FILTER - Update
Update operation of resource: option-filter
option-filterbody object
ID of profile-name
ID of mode
ID of matchoption pattern format
Request Content-Types: application/json
Request Example
{
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Create
Create operation of resource: option-filter
option-filterbody object
ID of profile-name
ID of mode
ID of matchoption pattern format
Request Content-Types: application/json
Request Example
{
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Delete
Delete operation of resource: option-filter
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Retrieve
Retrieve operation of resource: option-filter
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
DEF-OPTIONS - Update
Update operation of resource: def-options
def-optionsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Create
Create operation of resource: def-options
def-optionsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Delete
Delete operation of resource: def-options
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Retrieve
Retrieve operation of resource: def-options
ID of profile-name
ID of mode
Successful operation
Internal Error
DEF-OPTION - Update
Update operation of resource: def-option
def-optionbody object
ID of profile-name
ID of mode
ID of def-matchoption
Request Content-Types: application/json
Request Example
{
"def-matchaction": "string",
"def-matchoption": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTION - Create
Create operation of resource: def-option
def-optionbody object
ID of profile-name
ID of mode
ID of def-matchoption
Request Content-Types: application/json
Request Example
{
"def-matchaction": "string",
"def-matchoption": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTION - Delete
Delete operation of resource: def-option
ID of profile-name
ID of mode
ID of def-matchoption
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTION - Retrieve
Retrieve operation of resource: def-option
ID of profile-name
ID of mode
ID of def-matchoption
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"def-matchaction": "string",
"def-matchoption": "integer"
}
BASE-RELAY-OPT - Update
Update operation of resource: base-relay-opt
base-relay-optbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"authenticate": "integer",
"remote-id": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE-RELAY-OPT - Create
Create operation of resource: base-relay-opt
base-relay-optbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"authenticate": "integer",
"remote-id": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE-RELAY-OPT - Delete
Delete operation of resource: base-relay-opt
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BASE-RELAY-OPT - Retrieve
Retrieve operation of resource: base-relay-opt
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authenticate": "integer",
"remote-id": "string"
}
BASE-MATCH - Update
Update operation of resource: base-match
base-matchbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BASE-MATCH - Create
Create operation of resource: base-match
base-matchbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BASE-MATCH - Delete
Delete operation of resource: base-match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BASE-MATCH - Retrieve
Retrieve operation of resource: base-match
ID of profile-name
ID of mode
Successful operation
Internal Error
OPTIONS - Update
Update operation of resource: options
optionsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTIONS - Create
Create operation of resource: options
optionsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTIONS - Delete
Delete operation of resource: options
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTIONS - Retrieve
Retrieve operation of resource: options
ID of profile-name
ID of mode
Successful operation
Internal Error
OPTION - Update
Update operation of resource: option
optionbody object
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Successful operation
Internal Error
OPTION-PROFILE - Update
Update operation of resource: option-profile
option-profilebody object
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Request Content-Types: application/json
Request Example
{
"profile-name": "string",
"profile-mode": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-PROFILE - Create
Create operation of resource: option-profile
option-profilebody object
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Request Content-Types: application/json
Request Example
{
"profile-name": "string",
"profile-mode": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-PROFILE - Delete
Delete operation of resource: option-profile
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-PROFILE - Retrieve
Retrieve operation of resource: option-profile
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"profile-name": "string",
"profile-mode": "integer"
}
SERVER - Update
Update operation of resource: server
serverbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"subnet-mask": "string", "option-number": "integer",
"option-all": "integer"
}
}
},
"domain-name": "string",
"boot-filename": "string",
"next-server": "string", "dns-server": [ "string" ]
}, "check": [ null ]
}, {
"matchaction": "string",
"matchoption": "string"
}
]
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "string",
"format": "integer"
}
]
}
}, "infinite": "string",
"hours": "integer",
"minutes": "integer",
"days": "integer"
},
"server-allow-move": [ null ], "range": "integer",
"lease-limit-value": "string"
},
"secure-arp": [ null ], "authenticate": "integer"
},
"enable": [ null ], "policy": "string"
}, "net-bios-name-server": [ "string" ]
},
"pool": "string", "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
}, "default-router": [ "string" ]
}, "hybrid-node": "string",
"mixed-node": "string",
"hexadecimal": "string",
"broadcast-node": "string",
"peer-to-peer-node": "string"
}, "force-insert": [ null ]
}
}, "check": [ null ]
}, { "default-router": [ "string" ]
}, "l2-interface": "string"
}, {
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
]
}
}
]
}, {
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER - Create
Create operation of resource: server
serverbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"subnet-mask": "string", "option-number": "integer",
"option-all": "integer"
}
}
},
"domain-name": "string",
"boot-filename": "string",
"next-server": "string", "dns-server": [ "string" ]
}, "check": [ null ]
}, {
"matchaction": "string",
"matchoption": "string"
}
]
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "string",
"format": "integer"
}
]
}
}, "infinite": "string",
"hours": "integer",
"minutes": "integer",
"days": "integer"
},
"server-allow-move": [ null ], "range": "integer",
"lease-limit-value": "string"
},
"secure-arp": [ null ], "authenticate": "integer"
},
"enable": [ null ], "policy": "string"
}, "net-bios-name-server": [ "string" ]
},
"pool": "string", "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
}, "default-router": [ "string" ]
}, "hybrid-node": "string",
"mixed-node": "string",
"hexadecimal": "string",
"broadcast-node": "string",
"peer-to-peer-node": "string"
}, "force-insert": [ null ]
}
}, "check": [ null ]
}, { "default-router": [ "string" ]
}, "l2-interface": "string"
}, {
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
]
}
}
]
}, {
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER - Delete
Delete operation of resource: server
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SERVER - Retrieve
Retrieve operation of resource: server
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"subnet-mask": "string", "option-number": "integer",
"option-all": "integer"
}
}
},
"domain-name": "string",
"boot-filename": "string",
"next-server": "string", "dns-server": [ "string" ]
}, "check": [ null ]
}, {
"matchaction": "string",
"matchoption": "string"
}
]
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "string",
"format": "integer"
}
]
}
}, "infinite": "string",
"hours": "integer",
"minutes": "integer",
"days": "integer"
},
"server-allow-move": [ null ], "range": "integer",
"lease-limit-value": "string"
},
"secure-arp": [ null ], "authenticate": "integer"
},
"enable": [ null ], "policy": "string"
}, "net-bios-name-server": [ "string" ]
},
"pool": "string", "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
}, "default-router": [ "string" ]
}, "hybrid-node": "string",
"mixed-node": "string",
"hexadecimal": "string",
"broadcast-node": "string",
"peer-to-peer-node": "string"
}, "force-insert": [ null ]
}
}, "check": [ null ]
}, { "default-router": [ "string" ]
}, "l2-interface": "string"
}, {
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
]
}
}
]
}, {
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
]
}
}
SERVER-ID-CHECK - Update
Update operation of resource: server-id-check
server-id-checkbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"check": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-ID-CHECK - Create
Create operation of resource: server-id-check
server-id-checkbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"check": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-ID-CHECK - Delete
Delete operation of resource: server-id-check
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-ID-CHECK - Retrieve
Retrieve operation of resource: server-id-check
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"check": [ null ]
}
LEASE-LIMIT - Update
Update operation of resource: lease-limit
lease-limitbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"range": "integer",
"lease-limit-value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LEASE-LIMIT - Create
Create operation of resource: lease-limit
lease-limitbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"range": "integer",
"lease-limit-value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LEASE-LIMIT - Delete
Delete operation of resource: lease-limit
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LEASE-LIMIT - Retrieve
Retrieve operation of resource: lease-limit
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": "integer",
"lease-limit-value": "string"
}
REQUESTED-IP-ADDRESS - Update
Update operation of resource: requested-ip-address
requested-ip-addressbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"check": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
REQUESTED-IP-ADDRESS - Create
Create operation of resource: requested-ip-address
requested-ip-addressbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"check": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
REQUESTED-IP-ADDRESS - Delete
Delete operation of resource: requested-ip-address
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
REQUESTED-IP-ADDRESS - Retrieve
Retrieve operation of resource: requested-ip-address
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"check": [ null ]
}
AAA-SERVER - Update
Update operation of resource: aaa-server
aaa-serverbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
AAA-SERVER - Create
Create operation of resource: aaa-server
aaa-serverbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
AAA-SERVER - Delete
Delete operation of resource: aaa-server
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
AAA-SERVER - Retrieve
Retrieve operation of resource: aaa-server
ID of profile-name
ID of mode
Successful operation
Internal Error
DHCP-OPTION - Update
Update operation of resource: dhcp-option
dhcp-optionbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"force-insert": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-OPTION - Create
Create operation of resource: dhcp-option
dhcp-optionbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"force-insert": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-OPTION - Delete
Delete operation of resource: dhcp-option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-OPTION - Retrieve
Retrieve operation of resource: dhcp-option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"force-insert": [ null ]
}
DEFAULT-ROUTERS - Update
Update operation of resource: default-routers
default-routersbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"default-router": [ "string" ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Create
Create operation of resource: default-routers
default-routersbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"default-router": [ "string" ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Delete
Delete operation of resource: default-routers
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Retrieve
Retrieve operation of resource: default-routers
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-router": [ "string" ]
}
NET-BIOS-NAME-SERVERS - Update
Update operation of resource: net-bios-name-servers
net-bios-name-serversbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"net-bios-name-server": [ "string" ]
}
Successful operation
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Create
Create operation of resource: net-bios-name-servers
net-bios-name-serversbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"net-bios-name-server": [ "string" ]
}
Successful operation
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Delete
Delete operation of resource: net-bios-name-servers
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Retrieve
Retrieve operation of resource: net-bios-name-servers
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"net-bios-name-server": [ "string" ]
}
MATCH - Update
Update operation of resource: match
matchbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}
OPTION-DEFAULTS - Update
Update operation of resource: option-defaults
option-defaultsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-DEFAULTS - Create
Create operation of resource: option-defaults
option-defaultsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-DEFAULTS - Delete
Delete operation of resource: option-defaults
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-DEFAULTS - Retrieve
Retrieve operation of resource: option-defaults
ID of profile-name
ID of mode
Successful operation
Internal Error
OPTION-DEFAULT - Update
Update operation of resource: option-default
option-defaultbody object
ID of profile-name
ID of mode
ID of matchoption
Request Content-Types: application/json
Request Example
{
"matchaction": "string",
"matchoption": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-DEFAULT - Create
Create operation of resource: option-default
option-defaultbody object
ID of profile-name
ID of mode
ID of matchoption
Request Content-Types: application/json
Request Example
{
"matchaction": "string",
"matchoption": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-DEFAULT - Delete
Delete operation of resource: option-default
ID of profile-name
ID of mode
ID of matchoption
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-DEFAULT - Retrieve
Retrieve operation of resource: option-default
ID of profile-name
ID of mode
ID of matchoption
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"matchaction": "string",
"matchoption": "string"
}
OPTIONS - Update
Update operation of resource: options
optionsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTIONS - Create
Create operation of resource: options
optionsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTIONS - Delete
Delete operation of resource: options
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTIONS - Retrieve
Retrieve operation of resource: options
ID of profile-name
ID of mode
Successful operation
Internal Error
OPTION - Update
Update operation of resource: option
optionbody object
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
BROADCAST-FLAG - Update
Update operation of resource: broadcast-flag
broadcast-flagbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"policy": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Create
Create operation of resource: broadcast-flag
broadcast-flagbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"policy": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Delete
Delete operation of resource: broadcast-flag
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Retrieve
Retrieve operation of resource: broadcast-flag
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy": "string"
}
SESSION - Update
Update operation of resource: session
sessionbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Create
Create operation of resource: session
sessionbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Delete
Delete operation of resource: session
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Retrieve
Retrieve operation of resource: session
ID of profile-name
ID of mode
THROTTLE-TYPE - Update
Update operation of resource: throttle-type
throttle-typebody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
THROTTLE-TYPE - Create
Create operation of resource: throttle-type
throttle-typebody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
THROTTLE-TYPE - Delete
Delete operation of resource: throttle-type
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
THROTTLE-TYPE - Retrieve
Retrieve operation of resource: throttle-type
ID of profile-name
ID of mode
Successful operation
Internal Error
MAC-THROTTLE - Update
Update operation of resource: mac-throttle
mac-throttlebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
MAC-THROTTLE - Create
Create operation of resource: mac-throttle
mac-throttlebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
MAC-THROTTLE - Delete
Delete operation of resource: mac-throttle
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
MAC-THROTTLE - Retrieve
Retrieve operation of resource: mac-throttle
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
CLASSES - Update
Update operation of resource: classes
classesbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASSES - Create
Create operation of resource: classes
classesbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASSES - Delete
Delete operation of resource: classes
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
CLASSES - Retrieve
Retrieve operation of resource: classes
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}
CLASS - Update
Update operation of resource: class
classbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Create
Create operation of resource: class
classbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Delete
Delete operation of resource: class
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Retrieve
Retrieve operation of resource: class
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
DEFAULT-ROUTERS - Update
Update operation of resource: default-routers
default-routersbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{
"default-router": [ "string" ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Create
Create operation of resource: default-routers
default-routersbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{
"default-router": [ "string" ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Delete
Delete operation of resource: default-routers
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Retrieve
Retrieve operation of resource: default-routers
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-router": [ "string" ]
}
NET-BIOS-NAME-SERVERS - Update
Update operation of resource: net-bios-name-servers
net-bios-name-serversbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{
"net-bios-name-server": [ "string" ]
}
Successful operation
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Create
Create operation of resource: net-bios-name-servers
net-bios-name-serversbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{
"net-bios-name-server": [ "string" ]
}
Successful operation
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Delete
Delete operation of resource: net-bios-name-servers
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Retrieve
Retrieve operation of resource: net-bios-name-servers
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"net-bios-name-server": [ "string" ]
}
CLASS-MATCH - Update
Update operation of resource: class-match
class-matchbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-MATCH - Create
Create operation of resource: class-match
class-matchbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-MATCH - Delete
Delete operation of resource: class-match
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-MATCH - Retrieve
Retrieve operation of resource: class-match
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
CLASS-OPTIONS - Update
Update operation of resource: class-options
class-optionsbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-OPTIONS - Create
Create operation of resource: class-options
class-optionsbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-OPTIONS - Delete
Delete operation of resource: class-options
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-OPTIONS - Retrieve
Retrieve operation of resource: class-options
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
CLASS-OPTION - Update
Update operation of resource: class-option
class-optionbody object
ID of profile-name
ID of mode
ID of class-name
ID of matchoption
Request Content-Types: application/json
Request Example
{
"pattern": "string",
"matchoption": "string",
"bit-mask": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-OPTION - Create
Create operation of resource: class-option
class-optionbody object
ID of profile-name
ID of mode
ID of class-name
ID of matchoption
Request Content-Types: application/json
Request Example
{
"pattern": "string",
"matchoption": "string",
"bit-mask": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-OPTION - Delete
Delete operation of resource: class-option
ID of profile-name
ID of mode
ID of class-name
ID of matchoption
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-OPTION - Retrieve
Retrieve operation of resource: class-option
ID of profile-name
ID of mode
ID of class-name
ID of matchoption
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pattern": "string",
"matchoption": "string",
"bit-mask": "string"
}
LEASE - Update
Update operation of resource: lease
leasebody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{
"infinite": "string",
"hours": "integer",
"minutes": "integer",
"days": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
LEASE - Create
Create operation of resource: lease
leasebody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{
"infinite": "string",
"hours": "integer",
"minutes": "integer",
"days": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
LEASE - Delete
Delete operation of resource: lease
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
LEASE - Retrieve
Retrieve operation of resource: lease
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"infinite": "string",
"hours": "integer",
"minutes": "integer",
"days": "integer"
}
NETBIOS-NODE-TYPE - Update
Update operation of resource: netbios-node-type
netbios-node-typebody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{
"hybrid-node": "string",
"mixed-node": "string",
"hexadecimal": "string",
"broadcast-node": "string",
"peer-to-peer-node": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Create
Create operation of resource: netbios-node-type
netbios-node-typebody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{
"hybrid-node": "string",
"mixed-node": "string",
"hexadecimal": "string",
"broadcast-node": "string",
"peer-to-peer-node": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Delete
Delete operation of resource: netbios-node-type
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Retrieve
Retrieve operation of resource: netbios-node-type
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hybrid-node": "string",
"mixed-node": "string",
"hexadecimal": "string",
"broadcast-node": "string",
"peer-to-peer-node": "string"
}
DNS-SERVERS - Update
Update operation of resource: dns-servers
dns-serversbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{
"dns-server": [ "string" ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Create
Create operation of resource: dns-servers
dns-serversbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{
"dns-server": [ "string" ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Delete
Delete operation of resource: dns-servers
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Retrieve
Retrieve operation of resource: dns-servers
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dns-server": [ "string" ]
}
OPTION-CODES - Update
Update operation of resource: option-codes
option-codesbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODES - Create
Create operation of resource: option-codes
option-codesbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODES - Delete
Delete operation of resource: option-codes
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODES - Retrieve
Retrieve operation of resource: option-codes
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
OPTION-CODE - Update
Update operation of resource: option-code
option-codebody object
ID of profile-name
ID of mode
ID of class-name
ID of option-code
Request Content-Types: application/json
Request Example
{
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODE - Create
Create operation of resource: option-code
option-codebody object
ID of profile-name
ID of mode
ID of class-name
ID of option-code
Request Content-Types: application/json
Request Example
{
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODE - Delete
Delete operation of resource: option-code
ID of profile-name
ID of mode
ID of class-name
ID of option-code
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODE - Retrieve
Retrieve operation of resource: option-code
ID of profile-name
ID of mode
ID of class-name
ID of option-code
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
RELAY - Update
Update operation of resource: relay
relaybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}, {
"vrf-name": "string", {
"gateway-address": "string",
"enable": [ null ],
"ip-address": "string"
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY - Create
Create operation of resource: relay
relaybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}, {
"vrf-name": "string", {
"gateway-address": "string",
"enable": [ null ],
"ip-address": "string"
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY - Delete
Delete operation of resource: relay
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
RELAY - Retrieve
Retrieve operation of resource: relay
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}, {
"vrf-name": "string", {
"gateway-address": "string",
"enable": [ null ],
"ip-address": "string"
}
]
}
}
]
}
}
LEASE - Update
Update operation of resource: lease
leasebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"infinite": "string",
"hours": "integer",
"minutes": "integer",
"days": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
LEASE - Create
Create operation of resource: lease
leasebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"infinite": "string",
"hours": "integer",
"minutes": "integer",
"days": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
LEASE - Delete
Delete operation of resource: lease
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LEASE - Retrieve
Retrieve operation of resource: lease
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"infinite": "string",
"hours": "integer",
"minutes": "integer",
"days": "integer"
}
NETBIOS-NODE-TYPE - Update
Update operation of resource: netbios-node-type
netbios-node-typebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"hybrid-node": "string",
"mixed-node": "string",
"hexadecimal": "string",
"broadcast-node": "string",
"peer-to-peer-node": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Create
Create operation of resource: netbios-node-type
netbios-node-typebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"hybrid-node": "string",
"mixed-node": "string",
"hexadecimal": "string",
"broadcast-node": "string",
"peer-to-peer-node": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Delete
Delete operation of resource: netbios-node-type
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Retrieve
Retrieve operation of resource: netbios-node-type
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hybrid-node": "string",
"mixed-node": "string",
"hexadecimal": "string",
"broadcast-node": "string",
"peer-to-peer-node": "string"
}
DNS-SERVERS - Update
Update operation of resource: dns-servers
dns-serversbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"dns-server": [ "string" ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Create
Create operation of resource: dns-servers
dns-serversbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"dns-server": [ "string" ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Delete
Delete operation of resource: dns-servers
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Retrieve
Retrieve operation of resource: dns-servers
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dns-server": [ "string" ]
}
DHCP-TO-AAA - Update
Update operation of resource: dhcp-to-aaa
dhcp-to-aaabody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Create
Create operation of resource: dhcp-to-aaa
dhcp-to-aaabody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Delete
Delete operation of resource: dhcp-to-aaa
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Retrieve
Retrieve operation of resource: dhcp-to-aaa
ID of profile-name
ID of mode
OPTION - Update
Update operation of resource: option
optionbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
ID of profile-name
ID of mode
Successful operation
Internal Error
LIST - Update
Update operation of resource: list
listbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"option": [ "integer" ],
"option-all": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Create
Create operation of resource: list
listbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"option": [ "integer" ],
"option-all": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Delete
Delete operation of resource: list
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Retrieve
Retrieve operation of resource: list
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"option": [ "integer" ],
"option-all": "integer"
}
OPTION-CODES - Update
Update operation of resource: option-codes
option-codesbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODES - Create
Create operation of resource: option-codes
option-codesbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODES - Delete
Delete operation of resource: option-codes
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODES - Retrieve
Retrieve operation of resource: option-codes
ID of profile-name
ID of mode
Successful operation
Internal Error
OPTION-CODE - Update
Update operation of resource: option-code
option-codebody object
ID of profile-name
ID of mode
ID of option-code
Request Content-Types: application/json
Request Example
{
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODE - Create
Create operation of resource: option-code
option-codebody object
ID of profile-name
ID of mode
ID of option-code
Request Content-Types: application/json
Request Example
{
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODE - Delete
Delete operation of resource: option-code
ID of profile-name
ID of mode
ID of option-code
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODE - Retrieve
Retrieve operation of resource: option-code
ID of profile-name
ID of mode
ID of option-code
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
RELAY - Update
Update operation of resource: relay
relaybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}, {
"vrf-name": "string", {
"gateway-address": "string",
"enable": [ null ],
"ip-address": "string"
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY - Create
Create operation of resource: relay
relaybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}, {
"vrf-name": "string", {
"gateway-address": "string",
"enable": [ null ],
"ip-address": "string"
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY - Delete
Delete operation of resource: relay
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
RELAY - Retrieve
Retrieve operation of resource: relay
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy": "string"
}, "policy": "string"
},
"mac-mismatch-action": "string", "insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}, {
"vrf-name": "string", {
"gateway-address": "string",
"enable": [ null ],
"ip-address": "string"
}
]
}
}
]
}
}
GI-ADDR-POLICY - Update
Update operation of resource: gi-addr-policy
gi-addr-policybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"policy": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GI-ADDR-POLICY - Create
Create operation of resource: gi-addr-policy
gi-addr-policybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"policy": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GI-ADDR-POLICY - Delete
Delete operation of resource: gi-addr-policy
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
GI-ADDR-POLICY - Retrieve
Retrieve operation of resource: gi-addr-policy
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy": "string"
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
ID of profile-name
ID of mode
Successful operation
Internal Error
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of profile-name
ID of mode
ID of vrf-name
HELPER-ADDRESSES - Update
Update operation of resource: helper-addresses
helper-addressesbody object
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Create
Create operation of resource: helper-addresses
helper-addressesbody object
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Delete
Delete operation of resource: helper-addresses
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Retrieve
Retrieve operation of resource: helper-addresses
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
HELPER-ADDRESS - Update
Update operation of resource: helper-address
helper-addressbody object
ID of profile-name
ID of mode
ID of vrf-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"server-address": "string",
"gateway-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Create
Create operation of resource: helper-address
helper-addressbody object
ID of profile-name
ID of mode
ID of vrf-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"server-address": "string",
"gateway-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Delete
Delete operation of resource: helper-address
ID of profile-name
ID of mode
ID of vrf-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Retrieve
Retrieve operation of resource: helper-address
ID of profile-name
ID of mode
ID of vrf-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"server-address": "string",
"gateway-address": "string"
}
RELAY-INFORMATION-OPTION - Update
Update operation of resource: relay-information-option
relay-information-optionbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Create
Create operation of resource: relay-information-option
relay-information-optionbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Delete
Delete operation of resource: relay-information-option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Retrieve
Retrieve operation of resource: relay-information-option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
BROADCAST-POLICY - Update
Update operation of resource: broadcast-policy
broadcast-policybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"policy": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-POLICY - Create
Create operation of resource: broadcast-policy
broadcast-policybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"policy": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-POLICY - Delete
Delete operation of resource: broadcast-policy
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-POLICY - Retrieve
Retrieve operation of resource: broadcast-policy
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy": "string"
}
PROXY - Update
Update operation of resource: proxy
proxybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"proxy-allow-move": [ null ], "limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ], "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ], "arg1": "string",
"arg2": "string"
}, "policy": "string"
}, "set-server-options": [ null ],
"client-lease-time": "integer"
}, {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}, {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ], "policy": "string"
}, "option": [ "integer" ],
"option-all": "integer"
}
}
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, "authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROXY - Create
Create operation of resource: proxy
proxybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"proxy-allow-move": [ null ], "limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ], "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ], "arg1": "string",
"arg2": "string"
}, "policy": "string"
}, "set-server-options": [ null ],
"client-lease-time": "integer"
}, {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}, {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ], "policy": "string"
}, "option": [ "integer" ],
"option-all": "integer"
}
}
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, "authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROXY - Delete
Delete operation of resource: proxy
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
PROXY - Retrieve
Retrieve operation of resource: proxy
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"proxy-allow-move": [ null ], "limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ], "num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ], "arg1": "string",
"arg2": "string"
}, "policy": "string"
}, "set-server-options": [ null ],
"client-lease-time": "integer"
}, {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}, {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ], "policy": "string"
}, "option": [ "integer" ],
"option-all": "integer"
}
}
}, {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}, "authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
}
GIADDR - Update
Update operation of resource: giaddr
giaddrbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"policy": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GIADDR - Create
Create operation of resource: giaddr
giaddrbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"policy": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GIADDR - Delete
Delete operation of resource: giaddr
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
GIADDR - Retrieve
Retrieve operation of resource: giaddr
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy": "string"
}
CLASSES - Update
Update operation of resource: classes
classesbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASSES - Create
Create operation of resource: classes
classesbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASSES - Delete
Delete operation of resource: classes
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
CLASSES - Retrieve
Retrieve operation of resource: classes
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}
CLASS - Update
Update operation of resource: class
classbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Create
Create operation of resource: class
classbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Delete
Delete operation of resource: class
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Retrieve
Retrieve operation of resource: class
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ], {
"vrf-name": "string", {
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string", "pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
MATCH - Update
Update operation of resource: match
matchbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}
OPTION - Update
Update operation of resource: option
optionbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
HELPER-ADDRESSES - Update
Update operation of resource: helper-addresses
helper-addressesbody object
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Create
Create operation of resource: helper-addresses
helper-addressesbody object
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Delete
Delete operation of resource: helper-addresses
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Retrieve
Retrieve operation of resource: helper-addresses
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
HELPER-ADDRESS - Update
Update operation of resource: helper-address
helper-addressbody object
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
ID of server-address
Request Content-Types: application/json
Request Example
{
"server-address": "string",
"gateway-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Create
Create operation of resource: helper-address
helper-addressbody object
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
ID of server-address
Request Content-Types: application/json
Request Example
{
"server-address": "string",
"gateway-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Delete
Delete operation of resource: helper-address
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
ID of server-address
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Retrieve
Retrieve operation of resource: helper-address
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
ID of server-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"server-address": "string",
"gateway-address": "string"
}
AUTH-USERNAME - Update
Update operation of resource: auth-username
auth-usernamebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"arg1": "string",
"arg2": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTH-USERNAME - Create
Create operation of resource: auth-username
auth-usernamebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"arg1": "string",
"arg2": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTH-USERNAME - Delete
Delete operation of resource: auth-username
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
AUTH-USERNAME - Retrieve
Retrieve operation of resource: auth-username
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"arg1": "string",
"arg2": "string"
}
RELAY-INFORMATION - Update
Update operation of resource: relay-information
relay-informationbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION - Create
Create operation of resource: relay-information
relay-informationbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION - Delete
Delete operation of resource: relay-information
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION - Retrieve
Retrieve operation of resource: relay-information
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
DHCP-TO-AAA - Update
Update operation of resource: dhcp-to-aaa
dhcp-to-aaabody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Create
Create operation of resource: dhcp-to-aaa
dhcp-to-aaabody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Delete
Delete operation of resource: dhcp-to-aaa
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Retrieve
Retrieve operation of resource: dhcp-to-aaa
ID of profile-name
ID of mode
OPTION - Update
Update operation of resource: option
optionbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
ID of profile-name
ID of mode
Successful operation
Internal Error
LIST - Update
Update operation of resource: list
listbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"option": [ "integer" ],
"option-all": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Create
Create operation of resource: list
listbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"option": [ "integer" ],
"option-all": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Delete
Delete operation of resource: list
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Retrieve
Retrieve operation of resource: list
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"option": [ "integer" ],
"option-all": "integer"
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
ID of profile-name
ID of mode
Successful operation
Internal Error
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of profile-name
ID of mode
ID of vrf-name
HELPER-ADDRESSES - Update
Update operation of resource: helper-addresses
helper-addressesbody object
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Create
Create operation of resource: helper-addresses
helper-addressesbody object
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Delete
Delete operation of resource: helper-addresses
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Retrieve
Retrieve operation of resource: helper-addresses
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
HELPER-ADDRESS - Update
Update operation of resource: helper-address
helper-addressbody object
ID of profile-name
ID of mode
ID of vrf-name
ID of server-address
Request Content-Types: application/json
Request Example
{
"server-address": "string",
"gateway-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Create
Create operation of resource: helper-address
helper-addressbody object
ID of profile-name
ID of mode
ID of vrf-name
ID of server-address
Request Content-Types: application/json
Request Example
{
"server-address": "string",
"gateway-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Delete
Delete operation of resource: helper-address
ID of profile-name
ID of mode
ID of vrf-name
ID of server-address
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Retrieve
Retrieve operation of resource: helper-address
ID of profile-name
ID of mode
ID of vrf-name
ID of server-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"server-address": "string",
"gateway-address": "string"
}
SESSIONS - Update
Update operation of resource: sessions
sessionsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SESSIONS - Create
Create operation of resource: sessions
sessionsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SESSIONS - Delete
Delete operation of resource: sessions
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SESSIONS - Retrieve
Retrieve operation of resource: sessions
ID of profile-name
ID of mode
PROXY-THROTTLE-TYPE - Update
Update operation of resource: proxy-throttle-type
proxy-throttle-typebody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-THROTTLE-TYPE - Create
Create operation of resource: proxy-throttle-type
proxy-throttle-typebody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-THROTTLE-TYPE - Delete
Delete operation of resource: proxy-throttle-type
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-THROTTLE-TYPE - Retrieve
Retrieve operation of resource: proxy-throttle-type
ID of profile-name
ID of mode
Successful operation
Internal Error
PROXY-MAC-THROTTLE - Update
Update operation of resource: proxy-mac-throttle
proxy-mac-throttlebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-MAC-THROTTLE - Create
Create operation of resource: proxy-mac-throttle
proxy-mac-throttlebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-MAC-THROTTLE - Delete
Delete operation of resource: proxy-mac-throttle
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-MAC-THROTTLE - Retrieve
Retrieve operation of resource: proxy-mac-throttle
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
LIMIT-LEASE - Update
Update operation of resource: limit-lease
limit-leasebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"limit-lease-count": "string",
"limit-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LIMIT-LEASE - Create
Create operation of resource: limit-lease
limit-leasebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"limit-lease-count": "string",
"limit-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LIMIT-LEASE - Delete
Delete operation of resource: limit-lease
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIMIT-LEASE - Retrieve
Retrieve operation of resource: limit-lease
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"limit-lease-count": "string",
"limit-type": "string"
}
LEASE-PROXY - Update
Update operation of resource: lease-proxy
lease-proxybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"set-server-options": [ null ],
"client-lease-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
LEASE-PROXY - Create
Create operation of resource: lease-proxy
lease-proxybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"set-server-options": [ null ],
"client-lease-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
LEASE-PROXY - Delete
Delete operation of resource: lease-proxy
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LEASE-PROXY - Retrieve
Retrieve operation of resource: lease-proxy
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"set-server-options": [ null ],
"client-lease-time": "integer"
}
BROADCAST-FLAG - Update
Update operation of resource: broadcast-flag
broadcast-flagbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"policy": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Create
Create operation of resource: broadcast-flag
broadcast-flagbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{
"policy": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Delete
Delete operation of resource: broadcast-flag
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Retrieve
Retrieve operation of resource: broadcast-flag
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy": "string"
}
MATCH - Update
Update operation of resource: match
matchbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}, {
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}
DEF-OPTIONS - Update
Update operation of resource: def-options
def-optionsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Create
Create operation of resource: def-options
def-optionsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Delete
Delete operation of resource: def-options
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Retrieve
Retrieve operation of resource: def-options
ID of profile-name
ID of mode
Successful operation
Internal Error
DEF-OPTION - Update
Update operation of resource: def-option
def-optionbody object
ID of profile-name
ID of mode
ID of def-matchoption
Request Content-Types: application/json
Request Example
{
"def-matchaction": "string",
"def-matchoption": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTION - Create
Create operation of resource: def-option
def-optionbody object
ID of profile-name
ID of mode
ID of def-matchoption
Request Content-Types: application/json
Request Example
{
"def-matchaction": "string",
"def-matchoption": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTION - Delete
Delete operation of resource: def-option
ID of profile-name
ID of mode
ID of def-matchoption
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTION - Retrieve
Retrieve operation of resource: def-option
ID of profile-name
ID of mode
ID of def-matchoption
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"def-matchaction": "string",
"def-matchoption": "integer"
}
OPTION-FILTERS - Update
Update operation of resource: option-filters
option-filtersbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Create
Create operation of resource: option-filters
option-filtersbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Delete
Delete operation of resource: option-filters
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Retrieve
Retrieve operation of resource: option-filters
ID of profile-name
ID of mode
Successful operation
Internal Error
OPTION-FILTER - Update
Update operation of resource: option-filter
option-filterbody object
ID of profile-name
ID of mode
ID of matchoption pattern format
Request Content-Types: application/json
Request Example
{
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Create
Create operation of resource: option-filter
option-filterbody object
ID of profile-name
ID of mode
ID of matchoption pattern format
Request Content-Types: application/json
Request Example
{
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Delete
Delete operation of resource: option-filter
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Retrieve
Retrieve operation of resource: option-filter
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
DATABASE - Update
Update operation of resource: database
databasebody object
Request Content-Types: application/json
Request Example
{
"full-write-interval": "integer",
"incremental-write-interval": "integer",
"proxy": [ null ],
"snoop": [ null ],
"server": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE - Create
Create operation of resource: database
databasebody object
Request Content-Types: application/json
Request Example
{
"full-write-interval": "integer",
"incremental-write-interval": "integer",
"proxy": [ null ],
"snoop": [ null ],
"server": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE - Delete
Delete operation of resource: database
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE - Retrieve
Retrieve operation of resource: database
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"full-write-interval": "integer",
"incremental-write-interval": "integer",
"proxy": [ null ],
"snoop": [ null ],
"server": [ null ]
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ { "profile-name": "string",
"mode": "string"
},
"interface-name": "string", "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, {
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
]
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, }
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ { "profile-name": "string",
"mode": "string"
},
"interface-name": "string", "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, {
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
]
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, }
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "profile-name": "string",
"mode": "string"
},
"interface-name": "string", "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, {
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
]
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, }
]
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "profile-name": "string",
"mode": "string"
},
"interface-name": "string", "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, {
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
]
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "format-type": "integer"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "profile-name": "string",
"mode": "string"
},
"interface-name": "string", "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, {
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
]
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "format-type": "integer"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "profile-name": "string",
"mode": "string"
},
"interface-name": "string", "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, {
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
]
}
}, "profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}, "format-type": "integer"
}
}
}
PROXY-INTERFACE - Update
Update operation of resource: proxy-interface
proxy-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-INTERFACE - Create
Create operation of resource: proxy-interface
proxy-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-INTERFACE - Delete
Delete operation of resource: proxy-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-INTERFACE - Retrieve
Retrieve operation of resource: proxy-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
DHCP-CIRCUIT-ID - Update
Update operation of resource: dhcp-circuit-id
dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CIRCUIT-ID - Create
Create operation of resource: dhcp-circuit-id
dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CIRCUIT-ID - Delete
Delete operation of resource: dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
BASE-INTERFACE - Update
Update operation of resource: base-interface
base-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE-INTERFACE - Create
Create operation of resource: base-interface
base-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE-INTERFACE - Delete
Delete operation of resource: base-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BASE-INTERFACE - Retrieve
Retrieve operation of resource: base-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
BASE-DHCP-CIRCUIT-ID - Update
Update operation of resource: base-dhcp-circuit-id
base-dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE-DHCP-CIRCUIT-ID - Create
Create operation of resource: base-dhcp-circuit-id
base-dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE-DHCP-CIRCUIT-ID - Delete
Delete operation of resource: base-dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BASE-DHCP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: base-dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
RELAY-INTERFACE - Update
Update operation of resource: relay-interface
relay-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INTERFACE - Create
Create operation of resource: relay-interface
relay-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INTERFACE - Delete
Delete operation of resource: relay-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INTERFACE - Retrieve
Retrieve operation of resource: relay-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
RELAY-DHCP-CIRCUIT-ID - Update
Update operation of resource: relay-dhcp-circuit-id
relay-dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-DHCP-CIRCUIT-ID - Create
Create operation of resource: relay-dhcp-circuit-id
relay-dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-DHCP-CIRCUIT-ID - Delete
Delete operation of resource: relay-dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-DHCP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: relay-dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
STATIC-MODE - Update
Update operation of resource: static-mode
static-modebody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-MODE - Create
Create operation of resource: static-mode
static-modebody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-MODE - Delete
Delete operation of resource: static-mode
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-MODE - Retrieve
Retrieve operation of resource: static-mode
ID of interface-name
STATICS - Update
Update operation of resource: statics
staticsbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
STATICS - Create
Create operation of resource: statics
staticsbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
STATICS - Delete
Delete operation of resource: statics
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
STATICS - Retrieve
Retrieve operation of resource: statics
ID of interface-name
Successful operation
Internal Error
STATIC - Update
Update operation of resource: static
staticbody object
ID of interface-name
ID of mac-address client-id layer
Request Content-Types: application/json
Request Example
{
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC - Create
Create operation of resource: static
staticbody object
ID of interface-name
ID of mac-address client-id layer
Request Content-Types: application/json
Request Example
{
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC - Delete
Delete operation of resource: static
ID of interface-name
ID of mac-address client-id layer
Successful operation
Internal Error
Response Content-Types: application/json
STATIC - Retrieve
Retrieve operation of resource: static
ID of interface-name
ID of mac-address client-id layer
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
PROFILE - Update
Update operation of resource: profile
profilebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"profile-name": "string",
"mode": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Create
Create operation of resource: profile
profilebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"profile-name": "string",
"mode": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Delete
Delete operation of resource: profile
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Retrieve
Retrieve operation of resource: profile
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"profile-name": "string",
"mode": "string"
}
SERVER-INTERFACE - Update
Update operation of resource: server-interface
server-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-INTERFACE - Create
Create operation of resource: server-interface
server-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-INTERFACE - Delete
Delete operation of resource: server-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-INTERFACE - Retrieve
Retrieve operation of resource: server-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"profile": "string", "argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
SERVER-DHCP-CIRCUIT-ID - Update
Update operation of resource: server-dhcp-circuit-id
server-dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-DHCP-CIRCUIT-ID - Create
Create operation of resource: server-dhcp-circuit-id
server-dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-DHCP-CIRCUIT-ID - Delete
Delete operation of resource: server-dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-DHCP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: server-dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
SNOOP-INTERFACE - Update
Update operation of resource: snoop-interface
snoop-interfacebody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP-INTERFACE - Create
Create operation of resource: snoop-interface
snoop-interfacebody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP-INTERFACE - Delete
Delete operation of resource: snoop-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP-INTERFACE - Retrieve
Retrieve operation of resource: snoop-interface
ID of interface-name
Successful operation
Internal Error
SNOOP-CIRCUIT-ID - Update
Update operation of resource: snoop-circuit-id
snoop-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"format-type": "integer",
"circuit-id-value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP-CIRCUIT-ID - Create
Create operation of resource: snoop-circuit-id
snoop-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"format-type": "integer",
"circuit-id-value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP-CIRCUIT-ID - Delete
Delete operation of resource: snoop-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: snoop-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"format-type": "integer",
"circuit-id-value": "string"
}
DUPLICATE-MAC-ALLOWED - Update
Update operation of resource: duplicate-mac-allowed
duplicate-mac-allowedbody object
Request Content-Types: application/json
Request Example
{
"duplicate-mac": [ null ],
"exclude-vlan": [ null ],
"include-giaddr": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DUPLICATE-MAC-ALLOWED - Create
Create operation of resource: duplicate-mac-allowed
duplicate-mac-allowedbody object
Request Content-Types: application/json
Request Example
{
"duplicate-mac": [ null ],
"exclude-vlan": [ null ],
"include-giaddr": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DUPLICATE-MAC-ALLOWED - Delete
Delete operation of resource: duplicate-mac-allowed
Successful operation
Internal Error
Response Content-Types: application/json
DUPLICATE-MAC-ALLOWED - Retrieve
Retrieve operation of resource: duplicate-mac-allowed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"duplicate-mac": [ null ],
"exclude-vlan": [ null ],
"include-giaddr": [ null ]
}
RATE-LIMIT - Update
Update operation of resource: rate-limit
rate-limitbody object
Request Content-Types: application/json
Request Example
{
"num-period": "integer",
"num-discover": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
RATE-LIMIT - Create
Create operation of resource: rate-limit
rate-limitbody object
Request Content-Types: application/json
Request Example
{
"num-period": "integer",
"num-discover": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
RATE-LIMIT - Delete
Delete operation of resource: rate-limit
Successful operation
Internal Error
Response Content-Types: application/json
RATE-LIMIT - Retrieve
Retrieve operation of resource: rate-limit
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-period": "integer",
"num-discover": "integer"
}
Schema Definitions
OPTION-CODE-TABLE:
Common node of server, class
- option-codes: object
-
Table of OptionCode
-
- option-code: object[]
-
DHCP option code
-
object - option-code: integer
-
DHCP option code
range:"0..255" - hex-string: string
-
Hexadecimal string
- ascii-string: string
-
ASCII string
- ip-address: string[]
-
string Server's IP address
- force-insert: integer
-
Set constant integer
Example
{
"option-codes": {
"option-code": [
{
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
]
}
}
ipv4-dhcpd_schema:
DHCP IPV4 configuration
- enable: null
-
DHCP IPV4 configuration
- outer-cos: integer
-
Configure outer cos values for dhcp packets
range:"0..7" - database: object
-
Enable DHCP binding database storage to file system
-
- full-write-interval: integer
-
Full file write interval (default 10 minutes)
range:"1..1440" default:10 minutes)" - incremental-write-interval: integer
-
Incremental file write interval (default 1 minutes)
range:"1..1440" default:"1" - proxy: null
-
Enable DHCP proxy binding database storage to file system
- snoop: null
-
Enable DHCP snoop binding database storage to file system
- server: null
-
Enable DHCP server binding database storage to file system
- interfaces: object
-
DHCP IPV4 Interface Table
-
- interface: object[]
-
DHCP IPV4 Interface
-
object - profile: object
-
Profile name and mode
-
- profile-name: string
-
Profile name
- mode: string base, relay, snoop, server, proxy, base2
-
DHCP mode
- interface-name: string
-
Interface Name
- base-interface: object
-
DHCP IPv4 Base profile information
-
- profile: string
-
Interface profile name
- base-dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- proxy-interface: object
-
DHCP IPv4 proxy information
-
- profile: string
-
Interface profile name
- dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- static-mode: object
-
Static Table Entries containing MAC address to IP address bindings
-
- statics: object
-
Static Table Entries containing MAC address to IP address bindings
-
- static: object[]
-
DHCP static binding of Mac address to IP address
-
object - client-id: string
-
Client Id
- layer: string layer2, layer3
-
DHCP IPV4 Static layer
- static-address: string
-
IP address
- mac-address: string
-
MACAddress
- server-interface: object
-
DHCP IPv4 Server information
-
- profile: string
-
Interface profile name
- server-dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- relay-interface: object
-
DHCP IPv4 relay information
-
- relay-dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- snoop-interface: object
-
DHCP IPv4 snoop information
-
- snoop-circuit-id: object
-
Configure circuit ID for snoop 1. Hex 2. ASCII
-
- format-type: integer
-
Format type, 1. Hex 2. ASCII
range:"1..2" - circuit-id-value: string
-
Enter circuit-id value
- rate-limit: object
-
Rate limit ingress packets
-
- num-period: integer
-
Rate limiter period in msec (default: 200 msec)
range:"1..1000" default:"200" - num-discover: integer
-
Max DISCOVER packets per rate-limiter period (default 100)
range:"0..1000" default:"100"
- allow-client-id-change: null
-
For BNG session, allow client id change for a client MAC
- duplicate-mac-allowed: object
-
Allow Duplicate MAC Address
-
- duplicate-mac: null
-
Duplicate mac is allowed
- exclude-vlan: null
-
Exclude vlan
- include-giaddr: null
-
Include giaddr
- vrfs: object
-
VRF Table
-
- vrf: object[]
-
VRF table
-
object - profile: object
-
Profile name and mode
-
- mode: string base, relay, snoop, server, proxy, base2
-
Dhcp mode
- vrf-profile-name: string
-
Profile name
- vrf-name: string
-
VRF Name
- inner-cos: integer
-
Configure inner cos values for dhcp packets
range:"0..7" - profiles: object
-
DHCP IPV4 Profile Table
-
- profile: object[]
-
DHCP IPV4 Profile
-
object - modes: object
-
DHCP IPV4 Profile modes
-
- mode: object[]
-
DHCP IPV4 Profile mode
-
object - proxy: object
-
DHCP proxy profile
-
- proxy-allow-move: null
-
Allow dhcp subscriber move
- limit-lease: object
-
Proxy limit lease
-
- limit-lease-count: string
-
Limit lease count
- limit-type: string interface, circuit-id, remote-id, circuit-id-remote-id
-
Lease limit type
- secure-arp: null
-
DHCP IPV4 profile proxy secure-arp enable
- sessions: object
-
Change sessions configuration
-
- proxy-throttle-type: object
-
Throttle DHCP sessions based on MAC address
-
- proxy-mac-throttle: object
-
Throttle DHCP sessions from any one MAC address
-
- num-discover: integer
-
Number of discovers at which to throttle
range:"0..1000" default:"100" - num-block: integer
-
Throttle blocking period (in secs)
range:"1..100" units:"second" - num-request: integer
-
Throttle request period (in secs)
range:"1..100" units:"second"
- delayed-authen-proxy: null
-
For BNG session, delay the authentication
- auth-username: object
-
Authentication Username formating
-
- arg1: string auth-username-mac, auth-username-giaddr
-
Username Formatting first argument
- arg2: string auth-username-mac, auth-username-giaddr
-
Username Formatting second argument
- giaddr: object
-
Specify gateway address policy
-
- policy: string giaddr-policy-keep
-
Gateway address policy
- lease-proxy: object
-
DHCPv4 lease proxy
-
- set-server-options: null
-
Set DHCP server sent options in lease proxy generating ACK
- client-lease-time: integer
-
Specify client lease proxy time
range:"300..4294967295"
- classes: object
-
DHCP class table
-
- class: object[]
-
DHCP class
-
object - enable: null
-
Enable the DHCP IPV4 proxy class
- vrfs: object
-
List of VRFs
-
- vrf: object[]
-
VRF name
-
object - vrf-name: string
-
VRF name
- helper-addresses: object
-
Helper addresses
-
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
- class-name: string
-
Class name
- match: object
-
Match option
-
- option: object
-
Match option
-
- pattern: string
-
Hex pattern string
- bit-mask: string
-
Bit mask pattern
- option-type: string 60/60, 77/77, 124/124, 125/125
-
Match option
- vrf: string
-
Match VRF name
- vrfs: object
-
List of VRFs
-
- vrf: object[]
-
VRF name
-
object - vrf-name: string
-
VRF name
- helper-addresses: object
-
Helper addresses
-
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
- enable: null
-
DHCP IPV4 profile mode enable
- broadcast-flag: object
-
Specify broadcast flag
-
- policy: string ignore, check, unicast-always
-
Broadcast flag policy
- dhcp-to-aaa: object
-
Enable to provide the list of options need to send to aaa
-
- option: object
-
option type
-
- list: object
-
List of options
-
- option: integer[]
-
integer List of options
range:"1..255" - option-all: integer
-
option all
- match: object
-
Insert match keyword
-
- option-filters: object
-
Table of Option
-
- option-filter: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchaction: string allow, drop, relay
-
Vendor action
- matchoption: integer
-
Match option 60
- format: integer
-
Set constant integer
- def-options: object
-
Table of Option
-
- def-option: object[]
-
Specify match option
-
object - def-matchaction: string allow, drop, relay
-
Vendor action
- def-matchoption: integer
-
Match option 60
- relay-information: object
-
Relay agent information option
-
- authenticate: string received, inserted
-
Relay information option authenticate
- option: null
-
Insert relay rgent information circuit ID and remote ID suboptions in client requests
- remote-id-xr: null
-
Insert Remote-id sub-option
- allow-untrusted: null
-
Forward untrusted packets
- remote-id-suppress: null
-
Suppress Remote ID
- vpn-mode: string rfc, cisco
-
VPN Mode
- remote-id: string
-
Remote ID
- circuit-id: null
-
Insert Circuit-id sub-option
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- vpn: null
-
Insert VPN options
- check: null
-
Check relay agent information option in server reply
- enable: null
-
Enable the DHCP IPV4 Profile mode
- relay: object
-
DHCP Relay profile
-
- gi-addr-policy: object
-
GIADDR policy
-
- policy: string giaddr-policy-keep
-
GIADDR policy
- broadcast-policy: object
-
Broadcast Flag policy
-
- policy: string ignore, check, unicast-always
-
Broadcast flag policy
- mac-mismatch-action: string forward, drop
-
Action to take if L2 header source Mac and dhcp header mac address don't match
- relay-information-option: object
-
Relay agent information option
-
- insert: null
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client requests
- subscriber-id: string
-
Subscriber ID
- vpn-mode: string rfc, cisco
-
VPN Mode
- allow-untrusted: null
-
Forward untrusted packets
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- vpn: null
-
Insert VPN options
- check: null
-
Check Relay Agent Information Option in server reply
- vrfs: object
-
VRF Helper Addresses
-
- vrf: object[]
-
VRF Name
-
object - vrf-name: string
-
VRF Name
- helper-addresses: object
-
Helper Addresses
-
- helper-address: object[]
-
Helper Address
-
object - gateway-address: string
-
GatewayAddress
- enable: null
-
Enable helper - deprecated
- ip-address: string
-
IPV4 Address
- snoop: object
-
DHCP Snoop profile
-
- relay-information-option: object
-
DHCP Snoop profile
-
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- insert: null
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client request
- remote-id: object
-
Enter remote-id value
-
- format-type: integer
-
Format type, 1. Hex 2. ASCII
range:"1..2" - remote-id-value: string
-
Enter remote-id value
- allow-untrusted: null
-
Forward untrusted packets
- trusted: null
-
Trusted sources
- mode: string base, relay, snoop, server, proxy, base2
-
DHCP IPV4 Profile mode
- base: object
-
DHCP Base Profile
-
- default-profile: object
-
Enable the default profile
-
- profile-name: string
-
Profile name
- profile-mode: integer
-
none
- base-relay-opt: object
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client request
-
- authenticate: integer
-
Specify Relay Agent Information Option authenticate
- remote-id: string
-
Enter remote-id value
- enable: null
-
Enable the DHCP IPv4 Base Profile
- match: object
-
Insert match keyword
-
- option-filters: object
-
Table of Option
-
- option-filter: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchoption: integer
-
Match option 60
- option-action: string allow, drop
-
Vendor action
- format: integer
-
Set constant integer
- def-options: object
-
Table of Option
-
- def-option: object[]
-
Specify match option
-
object - def-matchaction: string allow, drop
-
Vendor action
- def-matchoption: integer
-
Match option 60
- base-match: object
-
Insert match keyword
-
- options: object
-
Specify match option
-
- option: object[]
-
none
-
object - opt60: integer
-
none
- option-profile: object
-
Enter a profile
-
- profile-name: string
-
Profile name
- profile-mode: integer
-
none
- opt60-hex-str: string
-
Enter hex pattern string
- format: integer
-
Set constant integer
- server:
-
DHCP Server profile
- profile-name: string
-
Profile Name
Example
{
"enable": [ null ],
"outer-cos": "integer",
"database": {
"full-write-interval": "integer",
"incremental-write-interval": "integer",
"proxy": [ null ],
"snoop": [ null ],
"server": [ null ]
},
"interfaces": {
"interface": [
{
"profile": {
"profile-name": "string",
"mode": "string"
},
"interface-name": "string",
"base-interface": {
"profile": "string",
"base-dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
},
"proxy-interface": {
"profile": "string",
"dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
},
"static-mode": {
"statics": {
"static": [
{
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
]
}
},
"server-interface": {
"profile": "string",
"server-dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
},
"relay-interface": {
"relay-dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string"
}
}
}
]
}
}
vrfs_schema:
List of VRFs
- vrf: object[]
-
VRF name
-
object - vrf-name: string
-
VRF name
- helper-addresses: object
-
Helper addresses
-
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
Example
{
"vrf": [
{
"vrf-name": "string",
"helper-addresses": {
"helper-address": [
{
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
}
vrf_schema:
- vrf-name: string
-
VRF name
- helper-addresses: object
-
Helper addresses
-
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
Example
{
"vrf-name": "string",
"helper-addresses": {
"helper-address": [
{
"server-address": "string",
"gateway-address": "string"
}
]
}
}
profile_schema:
Profile name and mode
- profile-name: string
-
Profile name
- mode: string base, relay, snoop, server, proxy, base2
-
DHCP mode
Example
{
"profile-name": "string",
"mode": "string"
}
profiles_schema:
DHCP IPV4 Profile Table
- profile: object[]
-
DHCP IPV4 Profile
-
object - modes: object
-
DHCP IPV4 Profile modes
-
- mode: object[]
-
DHCP IPV4 Profile mode
-
object - proxy: object
-
DHCP proxy profile
-
- proxy-allow-move: null
-
Allow dhcp subscriber move
- limit-lease: object
-
Proxy limit lease
-
- limit-lease-count: string
-
Limit lease count
- limit-type: string interface, circuit-id, remote-id, circuit-id-remote-id
-
Lease limit type
- secure-arp: null
-
DHCP IPV4 profile proxy secure-arp enable
- sessions: object
-
Change sessions configuration
-
- proxy-throttle-type: object
-
Throttle DHCP sessions based on MAC address
-
- proxy-mac-throttle: object
-
Throttle DHCP sessions from any one MAC address
-
- num-discover: integer
-
Number of discovers at which to throttle
range:"0..1000" default:"100" - num-block: integer
-
Throttle blocking period (in secs)
range:"1..100" units:"second" - num-request: integer
-
Throttle request period (in secs)
range:"1..100" units:"second"
- delayed-authen-proxy: null
-
For BNG session, delay the authentication
- auth-username: object
-
Authentication Username formating
-
- arg1: string auth-username-mac, auth-username-giaddr
-
Username Formatting first argument
- arg2: string auth-username-mac, auth-username-giaddr
-
Username Formatting second argument
- giaddr: object
-
Specify gateway address policy
-
- policy: string giaddr-policy-keep
-
Gateway address policy
- lease-proxy: object
-
DHCPv4 lease proxy
-
- set-server-options: null
-
Set DHCP server sent options in lease proxy generating ACK
- client-lease-time: integer
-
Specify client lease proxy time
range:"300..4294967295"
- classes: object
-
DHCP class table
-
- class: object[]
-
DHCP class
-
object - enable: null
-
Enable the DHCP IPV4 proxy class
- vrfs: object
-
List of VRFs
-
- vrf: object[]
-
VRF name
-
object - vrf-name: string
-
VRF name
- helper-addresses: object
-
Helper addresses
-
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
- class-name: string
-
Class name
- match: object
-
Match option
-
- option: object
-
Match option
-
- pattern: string
-
Hex pattern string
- bit-mask: string
-
Bit mask pattern
- option-type: string 60/60, 77/77, 124/124, 125/125
-
Match option
- vrf: string
-
Match VRF name
- vrfs: object
-
List of VRFs
-
- vrf: object[]
-
VRF name
-
object - vrf-name: string
-
VRF name
- helper-addresses: object
-
Helper addresses
-
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
- enable: null
-
DHCP IPV4 profile mode enable
- broadcast-flag: object
-
Specify broadcast flag
-
- policy: string ignore, check, unicast-always
-
Broadcast flag policy
- dhcp-to-aaa: object
-
Enable to provide the list of options need to send to aaa
-
- option: object
-
option type
-
- list: object
-
List of options
-
- option: integer[]
-
integer List of options
range:"1..255" - option-all: integer
-
option all
- match: object
-
Insert match keyword
-
- option-filters: object
-
Table of Option
-
- option-filter: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchaction: string allow, drop, relay
-
Vendor action
- matchoption: integer
-
Match option 60
- format: integer
-
Set constant integer
- def-options: object
-
Table of Option
-
- def-option: object[]
-
Specify match option
-
object - def-matchaction: string allow, drop, relay
-
Vendor action
- def-matchoption: integer
-
Match option 60
- relay-information: object
-
Relay agent information option
-
- authenticate: string received, inserted
-
Relay information option authenticate
- option: null
-
Insert relay rgent information circuit ID and remote ID suboptions in client requests
- remote-id-xr: null
-
Insert Remote-id sub-option
- allow-untrusted: null
-
Forward untrusted packets
- remote-id-suppress: null
-
Suppress Remote ID
- vpn-mode: string rfc, cisco
-
VPN Mode
- remote-id: string
-
Remote ID
- circuit-id: null
-
Insert Circuit-id sub-option
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- vpn: null
-
Insert VPN options
- check: null
-
Check relay agent information option in server reply
- enable: null
-
Enable the DHCP IPV4 Profile mode
- relay: object
-
DHCP Relay profile
-
- gi-addr-policy: object
-
GIADDR policy
-
- policy: string giaddr-policy-keep
-
GIADDR policy
- broadcast-policy: object
-
Broadcast Flag policy
-
- policy: string ignore, check, unicast-always
-
Broadcast flag policy
- mac-mismatch-action: string forward, drop
-
Action to take if L2 header source Mac and dhcp header mac address don't match
- relay-information-option: object
-
Relay agent information option
-
- insert: null
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client requests
- subscriber-id: string
-
Subscriber ID
- vpn-mode: string rfc, cisco
-
VPN Mode
- allow-untrusted: null
-
Forward untrusted packets
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- vpn: null
-
Insert VPN options
- check: null
-
Check Relay Agent Information Option in server reply
- vrfs: object
-
VRF Helper Addresses
-
- vrf: object[]
-
VRF Name
-
object - vrf-name: string
-
VRF Name
- helper-addresses: object
-
Helper Addresses
-
- helper-address: object[]
-
Helper Address
-
object - gateway-address: string
-
GatewayAddress
- enable: null
-
Enable helper - deprecated
- ip-address: string
-
IPV4 Address
- snoop: object
-
DHCP Snoop profile
-
- relay-information-option: object
-
DHCP Snoop profile
-
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- insert: null
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client request
- remote-id: object
-
Enter remote-id value
-
- format-type: integer
-
Format type, 1. Hex 2. ASCII
range:"1..2" - remote-id-value: string
-
Enter remote-id value
- allow-untrusted: null
-
Forward untrusted packets
- trusted: null
-
Trusted sources
- mode: string base, relay, snoop, server, proxy, base2
-
DHCP IPV4 Profile mode
- base: object
-
DHCP Base Profile
-
- default-profile: object
-
Enable the default profile
-
- profile-name: string
-
Profile name
- profile-mode: integer
-
none
- base-relay-opt: object
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client request
-
- authenticate: integer
-
Specify Relay Agent Information Option authenticate
- remote-id: string
-
Enter remote-id value
- enable: null
-
Enable the DHCP IPv4 Base Profile
- match: object
-
Insert match keyword
-
- option-filters: object
-
Table of Option
-
- option-filter: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchoption: integer
-
Match option 60
- option-action: string allow, drop
-
Vendor action
- format: integer
-
Set constant integer
- def-options: object
-
Table of Option
-
- def-option: object[]
-
Specify match option
-
object - def-matchaction: string allow, drop
-
Vendor action
- def-matchoption: integer
-
Match option 60
- base-match: object
-
Insert match keyword
-
- options: object
-
Specify match option
-
- option: object[]
-
none
-
object - opt60: integer
-
none
- option-profile: object
-
Enter a profile
-
- profile-name: string
-
Profile name
- profile-mode: integer
-
none
- opt60-hex-str: string
-
Enter hex pattern string
- format: integer
-
Set constant integer
- server:
-
DHCP Server profile
- profile-name: string
-
Profile Name
Example
{
"profile": [
{
"modes": {
"mode": [
{
"proxy": {
"proxy-allow-move": [ null ],
"limit-lease": {
"limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ],
"sessions": {
"proxy-throttle-type": {
"proxy-mac-throttle": {
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ],
"auth-username": {
"arg1": "string",
"arg2": "string"
},
"giaddr": {
"policy": "string"
},
"lease-proxy": {
"set-server-options": [ null ],
"client-lease-time": "integer"
},
"classes": {
"class": [
{
"enable": [ null ],
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"helper-addresses": {
"helper-address": [
{
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string",
"match": {
"option": {
"pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
},
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"helper-addresses": {
"helper-address": [
{
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ],
"broadcast-flag": {
"policy": "string"
},
"dhcp-to-aaa": {
"option": {
"list": {
"option": [ "integer" ],
"option-all": "integer"
}
}
},
"match": {
"option-filters": {
"option-filter": [
{
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
},
"def-options": {
"def-option": [
{
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
},
"relay-information": {
"authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
},
"enable": [ null ],
"relay": {
"gi-addr-policy": {
"policy": "string"
},
"broadcast-policy": {
"policy": "string"
},
"mac-mismatch-action": "string",
"relay-information-option": {
"insert": [ null ],
"subscriber-id": "string"
}
}
}
]
}
}
]
}
modes_schema:
DHCP IPV4 Profile modes
- mode: object[]
-
DHCP IPV4 Profile mode
-
object - proxy: object
-
DHCP proxy profile
-
- proxy-allow-move: null
-
Allow dhcp subscriber move
- limit-lease: object
-
Proxy limit lease
-
- limit-lease-count: string
-
Limit lease count
- limit-type: string interface, circuit-id, remote-id, circuit-id-remote-id
-
Lease limit type
- secure-arp: null
-
DHCP IPV4 profile proxy secure-arp enable
- sessions: object
-
Change sessions configuration
-
- proxy-throttle-type: object
-
Throttle DHCP sessions based on MAC address
-
- proxy-mac-throttle: object
-
Throttle DHCP sessions from any one MAC address
-
- num-discover: integer
-
Number of discovers at which to throttle
range:"0..1000" default:"100" - num-block: integer
-
Throttle blocking period (in secs)
range:"1..100" units:"second" - num-request: integer
-
Throttle request period (in secs)
range:"1..100" units:"second"
- delayed-authen-proxy: null
-
For BNG session, delay the authentication
- auth-username: object
-
Authentication Username formating
-
- arg1: string auth-username-mac, auth-username-giaddr
-
Username Formatting first argument
- arg2: string auth-username-mac, auth-username-giaddr
-
Username Formatting second argument
- giaddr: object
-
Specify gateway address policy
-
- policy: string giaddr-policy-keep
-
Gateway address policy
- lease-proxy: object
-
DHCPv4 lease proxy
-
- set-server-options: null
-
Set DHCP server sent options in lease proxy generating ACK
- client-lease-time: integer
-
Specify client lease proxy time
range:"300..4294967295"
- classes: object
-
DHCP class table
-
- class: object[]
-
DHCP class
-
object - enable: null
-
Enable the DHCP IPV4 proxy class
- vrfs: object
-
List of VRFs
-
- vrf: object[]
-
VRF name
-
object - vrf-name: string
-
VRF name
- helper-addresses: object
-
Helper addresses
-
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
- class-name: string
-
Class name
- match: object
-
Match option
-
- option: object
-
Match option
-
- pattern: string
-
Hex pattern string
- bit-mask: string
-
Bit mask pattern
- option-type: string 60/60, 77/77, 124/124, 125/125
-
Match option
- vrf: string
-
Match VRF name
- vrfs: object
-
List of VRFs
-
- vrf: object[]
-
VRF name
-
object - vrf-name: string
-
VRF name
- helper-addresses: object
-
Helper addresses
-
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
- enable: null
-
DHCP IPV4 profile mode enable
- broadcast-flag: object
-
Specify broadcast flag
-
- policy: string ignore, check, unicast-always
-
Broadcast flag policy
- dhcp-to-aaa: object
-
Enable to provide the list of options need to send to aaa
-
- option: object
-
option type
-
- list: object
-
List of options
-
- option: integer[]
-
integer List of options
range:"1..255" - option-all: integer
-
option all
- match: object
-
Insert match keyword
-
- option-filters: object
-
Table of Option
-
- option-filter: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchaction: string allow, drop, relay
-
Vendor action
- matchoption: integer
-
Match option 60
- format: integer
-
Set constant integer
- def-options: object
-
Table of Option
-
- def-option: object[]
-
Specify match option
-
object - def-matchaction: string allow, drop, relay
-
Vendor action
- def-matchoption: integer
-
Match option 60
- relay-information: object
-
Relay agent information option
-
- authenticate: string received, inserted
-
Relay information option authenticate
- option: null
-
Insert relay rgent information circuit ID and remote ID suboptions in client requests
- remote-id-xr: null
-
Insert Remote-id sub-option
- allow-untrusted: null
-
Forward untrusted packets
- remote-id-suppress: null
-
Suppress Remote ID
- vpn-mode: string rfc, cisco
-
VPN Mode
- remote-id: string
-
Remote ID
- circuit-id: null
-
Insert Circuit-id sub-option
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- vpn: null
-
Insert VPN options
- check: null
-
Check relay agent information option in server reply
- enable: null
-
Enable the DHCP IPV4 Profile mode
- relay: object
-
DHCP Relay profile
-
- gi-addr-policy: object
-
GIADDR policy
-
- policy: string giaddr-policy-keep
-
GIADDR policy
- broadcast-policy: object
-
Broadcast Flag policy
-
- policy: string ignore, check, unicast-always
-
Broadcast flag policy
- mac-mismatch-action: string forward, drop
-
Action to take if L2 header source Mac and dhcp header mac address don't match
- relay-information-option: object
-
Relay agent information option
-
- insert: null
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client requests
- subscriber-id: string
-
Subscriber ID
- vpn-mode: string rfc, cisco
-
VPN Mode
- allow-untrusted: null
-
Forward untrusted packets
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- vpn: null
-
Insert VPN options
- check: null
-
Check Relay Agent Information Option in server reply
- vrfs: object
-
VRF Helper Addresses
-
- vrf: object[]
-
VRF Name
-
object - vrf-name: string
-
VRF Name
- helper-addresses: object
-
Helper Addresses
-
- helper-address: object[]
-
Helper Address
-
object - gateway-address: string
-
GatewayAddress
- enable: null
-
Enable helper - deprecated
- ip-address: string
-
IPV4 Address
- snoop: object
-
DHCP Snoop profile
-
- relay-information-option: object
-
DHCP Snoop profile
-
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- insert: null
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client request
- remote-id: object
-
Enter remote-id value
-
- format-type: integer
-
Format type, 1. Hex 2. ASCII
range:"1..2" - remote-id-value: string
-
Enter remote-id value
- allow-untrusted: null
-
Forward untrusted packets
- trusted: null
-
Trusted sources
- mode: string base, relay, snoop, server, proxy, base2
-
DHCP IPV4 Profile mode
- base: object
-
DHCP Base Profile
-
- default-profile: object
-
Enable the default profile
-
- profile-name: string
-
Profile name
- profile-mode: integer
-
none
- base-relay-opt: object
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client request
-
- authenticate: integer
-
Specify Relay Agent Information Option authenticate
- remote-id: string
-
Enter remote-id value
- enable: null
-
Enable the DHCP IPv4 Base Profile
- match: object
-
Insert match keyword
-
- option-filters: object
-
Table of Option
-
- option-filter: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchoption: integer
-
Match option 60
- option-action: string allow, drop
-
Vendor action
- format: integer
-
Set constant integer
- def-options: object
-
Table of Option
-
- def-option: object[]
-
Specify match option
-
object - def-matchaction: string allow, drop
-
Vendor action
- def-matchoption: integer
-
Match option 60
- base-match: object
-
Insert match keyword
-
- options: object
-
Specify match option
-
- option: object[]
-
none
-
object - opt60: integer
-
none
- option-profile: object
-
Enter a profile
-
- profile-name: string
-
Profile name
- profile-mode: integer
-
none
- opt60-hex-str: string
-
Enter hex pattern string
- format: integer
-
Set constant integer
- server:
-
DHCP Server profile
Example
{
"mode": [
{
"proxy": {
"proxy-allow-move": [ null ],
"limit-lease": {
"limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ],
"sessions": {
"proxy-throttle-type": {
"proxy-mac-throttle": {
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ],
"auth-username": {
"arg1": "string",
"arg2": "string"
},
"giaddr": {
"policy": "string"
},
"lease-proxy": {
"set-server-options": [ null ],
"client-lease-time": "integer"
},
"classes": {
"class": [
{
"enable": [ null ],
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"helper-addresses": {
"helper-address": [
{
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string",
"match": {
"option": {
"pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
},
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"helper-addresses": {
"helper-address": [
{
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ],
"broadcast-flag": {
"policy": "string"
},
"dhcp-to-aaa": {
"option": {
"list": {
"option": [ "integer" ],
"option-all": "integer"
}
}
},
"match": {
"option-filters": {
"option-filter": [
{
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
},
"def-options": {
"def-option": [
{
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
},
"relay-information": {
"authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
},
"enable": [ null ],
"relay": {
"gi-addr-policy": {
"policy": "string"
},
"broadcast-policy": {
"policy": "string"
},
"mac-mismatch-action": "string",
"relay-information-option": {
"insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string"
}
}
}
]
}
mode_schema:
- proxy: object
-
DHCP proxy profile
-
- proxy-allow-move: null
-
Allow dhcp subscriber move
- limit-lease: object
-
Proxy limit lease
-
- limit-lease-count: string
-
Limit lease count
- limit-type: string interface, circuit-id, remote-id, circuit-id-remote-id
-
Lease limit type
- secure-arp: null
-
DHCP IPV4 profile proxy secure-arp enable
- sessions: object
-
Change sessions configuration
-
- proxy-throttle-type: object
-
Throttle DHCP sessions based on MAC address
-
- proxy-mac-throttle: object
-
Throttle DHCP sessions from any one MAC address
-
- num-discover: integer
-
Number of discovers at which to throttle
range:"0..1000" default:"100" - num-block: integer
-
Throttle blocking period (in secs)
range:"1..100" units:"second" - num-request: integer
-
Throttle request period (in secs)
range:"1..100" units:"second"
- delayed-authen-proxy: null
-
For BNG session, delay the authentication
- auth-username: object
-
Authentication Username formating
-
- arg1: string auth-username-mac, auth-username-giaddr
-
Username Formatting first argument
- arg2: string auth-username-mac, auth-username-giaddr
-
Username Formatting second argument
- giaddr: object
-
Specify gateway address policy
-
- policy: string giaddr-policy-keep
-
Gateway address policy
- lease-proxy: object
-
DHCPv4 lease proxy
-
- set-server-options: null
-
Set DHCP server sent options in lease proxy generating ACK
- client-lease-time: integer
-
Specify client lease proxy time
range:"300..4294967295"
- classes: object
-
DHCP class table
-
- class: object[]
-
DHCP class
-
object - enable: null
-
Enable the DHCP IPV4 proxy class
- vrfs: object
-
List of VRFs
-
- vrf: object[]
-
VRF name
-
object - vrf-name: string
-
VRF name
- helper-addresses: object
-
Helper addresses
-
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
- class-name: string
-
Class name
- match: object
-
Match option
-
- option: object
-
Match option
-
- pattern: string
-
Hex pattern string
- bit-mask: string
-
Bit mask pattern
- option-type: string 60/60, 77/77, 124/124, 125/125
-
Match option
- vrf: string
-
Match VRF name
- vrfs: object
-
List of VRFs
-
- vrf: object[]
-
VRF name
-
object - vrf-name: string
-
VRF name
- helper-addresses: object
-
Helper addresses
-
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
- enable: null
-
DHCP IPV4 profile mode enable
- broadcast-flag: object
-
Specify broadcast flag
-
- policy: string ignore, check, unicast-always
-
Broadcast flag policy
- dhcp-to-aaa: object
-
Enable to provide the list of options need to send to aaa
-
- option: object
-
option type
-
- list: object
-
List of options
-
- option: integer[]
-
integer List of options
range:"1..255" - option-all: integer
-
option all
- match: object
-
Insert match keyword
-
- option-filters: object
-
Table of Option
-
- option-filter: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchaction: string allow, drop, relay
-
Vendor action
- matchoption: integer
-
Match option 60
- format: integer
-
Set constant integer
- def-options: object
-
Table of Option
-
- def-option: object[]
-
Specify match option
-
object - def-matchaction: string allow, drop, relay
-
Vendor action
- def-matchoption: integer
-
Match option 60
- relay-information: object
-
Relay agent information option
-
- authenticate: string received, inserted
-
Relay information option authenticate
- option: null
-
Insert relay rgent information circuit ID and remote ID suboptions in client requests
- remote-id-xr: null
-
Insert Remote-id sub-option
- allow-untrusted: null
-
Forward untrusted packets
- remote-id-suppress: null
-
Suppress Remote ID
- vpn-mode: string rfc, cisco
-
VPN Mode
- remote-id: string
-
Remote ID
- circuit-id: null
-
Insert Circuit-id sub-option
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- vpn: null
-
Insert VPN options
- check: null
-
Check relay agent information option in server reply
- enable: null
-
Enable the DHCP IPV4 Profile mode
- relay: object
-
DHCP Relay profile
-
- gi-addr-policy: object
-
GIADDR policy
-
- policy: string giaddr-policy-keep
-
GIADDR policy
- broadcast-policy: object
-
Broadcast Flag policy
-
- policy: string ignore, check, unicast-always
-
Broadcast flag policy
- mac-mismatch-action: string forward, drop
-
Action to take if L2 header source Mac and dhcp header mac address don't match
- relay-information-option: object
-
Relay agent information option
-
- insert: null
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client requests
- subscriber-id: string
-
Subscriber ID
- vpn-mode: string rfc, cisco
-
VPN Mode
- allow-untrusted: null
-
Forward untrusted packets
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- vpn: null
-
Insert VPN options
- check: null
-
Check Relay Agent Information Option in server reply
- vrfs: object
-
VRF Helper Addresses
-
- vrf: object[]
-
VRF Name
-
object - vrf-name: string
-
VRF Name
- helper-addresses: object
-
Helper Addresses
-
- helper-address: object[]
-
Helper Address
-
object - gateway-address: string
-
GatewayAddress
- enable: null
-
Enable helper - deprecated
- ip-address: string
-
IPV4 Address
- snoop: object
-
DHCP Snoop profile
-
- relay-information-option: object
-
DHCP Snoop profile
-
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- insert: null
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client request
- remote-id: object
-
Enter remote-id value
-
- format-type: integer
-
Format type, 1. Hex 2. ASCII
range:"1..2" - remote-id-value: string
-
Enter remote-id value
- allow-untrusted: null
-
Forward untrusted packets
- trusted: null
-
Trusted sources
- mode: string base, relay, snoop, server, proxy, base2
-
DHCP IPV4 Profile mode
- base: object
-
DHCP Base Profile
-
- default-profile: object
-
Enable the default profile
-
- profile-name: string
-
Profile name
- profile-mode: integer
-
none
- base-relay-opt: object
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client request
-
- authenticate: integer
-
Specify Relay Agent Information Option authenticate
- remote-id: string
-
Enter remote-id value
- enable: null
-
Enable the DHCP IPv4 Base Profile
- match: object
-
Insert match keyword
-
- option-filters: object
-
Table of Option
-
- option-filter: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchoption: integer
-
Match option 60
- option-action: string allow, drop
-
Vendor action
- format: integer
-
Set constant integer
- def-options: object
-
Table of Option
-
- def-option: object[]
-
Specify match option
-
object - def-matchaction: string allow, drop
-
Vendor action
- def-matchoption: integer
-
Match option 60
- base-match: object
-
Insert match keyword
-
- options: object
-
Specify match option
-
- option: object[]
-
none
-
object - opt60: integer
-
none
- option-profile: object
-
Enter a profile
-
- profile-name: string
-
Profile name
- profile-mode: integer
-
none
- opt60-hex-str: string
-
Enter hex pattern string
- format: integer
-
Set constant integer
- server:
-
DHCP Server profile
Example
{
"proxy": {
"proxy-allow-move": [ null ],
"limit-lease": {
"limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ],
"sessions": {
"proxy-throttle-type": {
"proxy-mac-throttle": {
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ],
"auth-username": {
"arg1": "string",
"arg2": "string"
},
"giaddr": {
"policy": "string"
},
"lease-proxy": {
"set-server-options": [ null ],
"client-lease-time": "integer"
},
"classes": {
"class": [
{
"enable": [ null ],
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"helper-addresses": {
"helper-address": [
{
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string",
"match": {
"option": {
"pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
},
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"helper-addresses": {
"helper-address": [
{
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ],
"broadcast-flag": {
"policy": "string"
},
"dhcp-to-aaa": {
"option": {
"list": {
"option": [ "integer" ],
"option-all": "integer"
}
}
},
"match": {
"option-filters": {
"option-filter": [
{
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
},
"def-options": {
"def-option": [
{
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
},
"relay-information": {
"authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
},
"enable": [ null ],
"relay": {
"gi-addr-policy": {
"policy": "string"
},
"broadcast-policy": {
"policy": "string"
},
"mac-mismatch-action": "string",
"relay-information-option": {
"insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
}
}
snoop_schema:
DHCP Snoop profile
- relay-information-option: object
-
DHCP Snoop profile
-
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- insert: null
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client request
- remote-id: object
-
Enter remote-id value
-
- format-type: integer
-
Format type, 1. Hex 2. ASCII
range:"1..2" - remote-id-value: string
-
Enter remote-id value
- allow-untrusted: null
-
Forward untrusted packets
- trusted: null
-
Trusted sources
Example
{
"relay-information-option": {
"policy": "string",
"insert": [ null ],
"remote-id": {
"format-type": "integer",
"remote-id-value": "string"
},
"allow-untrusted": [ null ]
},
"trusted": [ null ]
}
relay-information-option_schema:
Relay agent information option
- insert: null
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client requests
- subscriber-id: string
-
Subscriber ID
- vpn-mode: string rfc, cisco
-
VPN Mode
- allow-untrusted: null
-
Forward untrusted packets
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- vpn: null
-
Insert VPN options
- check: null
-
Check Relay Agent Information Option in server reply
Example
{
"insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
remote-id_schema:
Enter remote-id value
- format-type: integer
-
Format type, 1. Hex 2. ASCII
range:"1..2" - remote-id-value: string
-
Enter remote-id value
Example
{
"format-type": "integer",
"remote-id-value": "string"
}
base_schema:
DHCP Base Profile
- default-profile: object
-
Enable the default profile
-
- profile-name: string
-
Profile name
- profile-mode: integer
-
none
- base-relay-opt: object
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client request
-
- authenticate: integer
-
Specify Relay Agent Information Option authenticate
- remote-id: string
-
Enter remote-id value
- enable: null
-
Enable the DHCP IPv4 Base Profile
- match: object
-
Insert match keyword
-
- option-filters: object
-
Table of Option
-
- option-filter: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchoption: integer
-
Match option 60
- option-action: string allow, drop
-
Vendor action
- format: integer
-
Set constant integer
- def-options: object
-
Table of Option
-
- def-option: object[]
-
Specify match option
-
object - def-matchaction: string allow, drop
-
Vendor action
- def-matchoption: integer
-
Match option 60
- base-match: object
-
Insert match keyword
-
- options: object
-
Specify match option
-
- option: object[]
-
none
-
object - opt60: integer
-
none
- option-profile: object
-
Enter a profile
-
- profile-name: string
-
Profile name
- profile-mode: integer
-
none
- opt60-hex-str: string
-
Enter hex pattern string
- format: integer
-
Set constant integer
Example
{
"default-profile": {
"profile-name": "string",
"profile-mode": "integer"
},
"base-relay-opt": {
"authenticate": "integer",
"remote-id": "string"
},
"enable": [ null ],
"match": {
"option-filters": {
"option-filter": [
{
"pattern": "string",
"matchoption": "integer",
"option-action": "string",
"format": "integer"
}
]
},
"def-options": {
"def-option": [
{
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
},
"base-match": {
"options": {
"option": [
{
"opt60": "integer",
"option-profile": {
"profile-name": "string",
"profile-mode": "integer"
},
"opt60-hex-str": "string",
"format": "integer"
}
]
}
}
}
default-profile_schema:
Enable the default profile
- profile-name: string
-
Profile name
- profile-mode: integer
-
none
Example
{
"profile-name": "string",
"profile-mode": "integer"
}
match_schema:
Insert match keyword
- option-filters: object
-
Table of Option
-
- option-filter: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchaction: string allow, drop, relay
-
Vendor action
- matchoption: integer
-
Match option 60
- format: integer
-
Set constant integer
- def-options: object
-
Table of Option
-
- def-option: object[]
-
Specify match option
-
object - def-matchaction: string allow, drop, relay
-
Vendor action
- def-matchoption: integer
-
Match option 60
Example
{
"option-filters": {
"option-filter": [
{
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
},
"def-options": {
"def-option": [
{
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
}
option-filters_schema:
Table of Option
- option-filter: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchaction: string allow, drop, relay
-
Vendor action
- matchoption: integer
-
Match option 60
- format: integer
-
Set constant integer
Example
{
"option-filter": [
{
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
}
option-filter_schema:
- pattern: string
-
Enter hex pattern string
- matchaction: string allow, drop, relay
-
Vendor action
- matchoption: integer
-
Match option 60
- format: integer
-
Set constant integer
Example
{
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
def-options_schema:
Table of Option
- def-option: object[]
-
Specify match option
-
object - def-matchaction: string allow, drop, relay
-
Vendor action
- def-matchoption: integer
-
Match option 60
Example
{
"def-option": [
{
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
def-option_schema:
- def-matchaction: string allow, drop, relay
-
Vendor action
- def-matchoption: integer
-
Match option 60
Example
{
"def-matchaction": "string",
"def-matchoption": "integer"
}
base-relay-opt_schema:
Insert Relay Agent Information circuit ID and remote ID suboptions in client request
- authenticate: integer
-
Specify Relay Agent Information Option authenticate
- remote-id: string
-
Enter remote-id value
Example
{
"authenticate": "integer",
"remote-id": "string"
}
base-match_schema:
Insert match keyword
- options: object
-
Specify match option
-
- option: object[]
-
none
-
object - opt60: integer
-
none
- option-profile: object
-
Enter a profile
-
- profile-name: string
-
Profile name
- profile-mode: integer
-
none
- opt60-hex-str: string
-
Enter hex pattern string
- format: integer
-
Set constant integer
Example
{
"options": {
"option": [
{
"opt60": "integer",
"option-profile": {
"profile-name": "string",
"profile-mode": "integer"
},
"opt60-hex-str": "string",
"format": "integer"
}
]
}
}
options_schema:
Table of Option
- option: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchaction: string allow, drop
-
Vendor action
- matchoption: string circuitid, remoteid, 60, 77, 124, 125
-
Match option 60
- format: integer
-
Set constant integer
Example
{
"option": [
{
"pattern": "string",
"matchaction": "string",
"matchoption": "string",
"format": "integer"
}
]
}
option_schema:
option type
- list: object
-
List of options
-
- option: integer[]
-
integer List of options
range:"1..255" - option-all: integer
-
option all
Example
{
"list": {
"option": [ "integer" ],
"option-all": "integer"
}
}
option-profile_schema:
Enter a profile
- profile-name: string
-
Profile name
- profile-mode: integer
-
none
Example
{
"profile-name": "string",
"profile-mode": "integer"
}
server_schema:
DHCP Server profile
- subnet-mask: string
-
Configure Subnet Mask
- dhcp-to-aaa: object
-
Enable to provide the list of options need to send to aaa
-
- option: object
-
option type
-
- list: object
-
List of options
-
- option-number: integer
-
Option number
range:"1..255" - option-all: integer
-
Set constant integer
- domain-name: string
-
Domain name
- boot-filename: string
-
Boot Filename
- next-server: string
-
Configure the tftp-server IP to be used by the client
- dns-servers: object
-
DNS servers
-
- dns-server: string[]
-
string DNS Server's IP address
- server-id-check: object
-
Validate server ID check
-
- check: null
-
specify server-id-check disable
- match: object
-
Insert match keyword
-
- option-defaults: object
-
Table of OptionDefault
-
- option-default: object[]
-
Specify match option
-
object - matchaction: string allow, drop
-
Vendor action
- matchoption: string circuitid, remoteid, 60, 77, 124, 125
-
Match option 60
- options: object
-
Table of Option
-
- option: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchaction: string allow, drop
-
Vendor action
- matchoption: string circuitid, remoteid, 60, 77, 124, 125
-
Match option 60
- format: integer
-
Set constant integer
- lease: object
-
lease
-
- infinite: string
-
Set string
- hours: integer
-
Hours
range:"0..23" units:"hour" - minutes: integer
-
Minutes
range:"1..59" units:"minute" - days: integer
-
Days
range:"0..365" units:"day"
- server-allow-move: null
-
Allow dhcp subscriber move
- lease-limit: object
-
Specify limit lease
-
- range: integer
-
Value of limit lease count in Decimal
range:"1..240000" - lease-limit-value: string per-interface, per-circuit-id, per-remote-id
-
Configure Lease limit value
- secure-arp: null
-
Enable Secure Arp
- relay: object
-
Specify Relay Agent Information Option configuration
-
- authenticate: integer
-
Specify Relay Agent Information Option authenticate
- enable: null
-
DHCP IPV4 profile mode enable
- broadcast-flag: object
-
None
-
- policy: string ignore, check, unicastalways
-
Specify broadcast flag policy
- net-bios-name-servers: object
-
NetBIOS name servers
-
- net-bios-name-server: string[]
-
string NetBIOSNameServer's IP address
- pool: string
-
Specify the Pool name
- session: object
-
Change sessions configuration
-
- throttle-type: object
-
Throttle DHCP sessions based on MAC address
-
- mac-throttle: object
-
Throttle DHCP sessions from any one MAC address
-
- num-discover: integer
-
Number of discovers at which to throttle
range:"0..1000" default:"100" - num-block: integer
-
Throttle blocking period (in secs)
range:"1..100" units:"second" - num-request: integer
-
Throttle request period (in secs)
range:"1..100" units:"second"
- default-routers: object
-
default routers
-
- default-router: string[]
-
string Router's IP address
- netbios-node-type: object
-
NetBIOS node type
-
- hybrid-node: string
-
Set string
- mixed-node: string
-
Set string
- hexadecimal: string
-
Hexadecimal number
- broadcast-node: string
-
Set string
- peer-to-peer-node: string
-
Set string
- aaa-server: object
-
Enable aaa dhcp option force-insert
-
- dhcp-option: object
-
Enable aaa dhcp option force-insert
-
- force-insert: null
-
Enable aaa dhcp option force-insert
- requested-ip-address: object
-
Validate Requested IP Address
-
- check: null
-
specify requested-ip-address-check disable
- classes: object
-
Table of Class
-
- class: object[]
-
Create or enter server profile class
-
- default-routers: object
-
default routers
-
- default-router: string[]
-
string Router's IP address
- class-match: object
-
Insert match keyword
-
- l2-interface: string
-
Specify match l2-interface
- class-options: object
-
Table of Class-Option
-
- class-option: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchoption: string circuitid, remoteid, 60, 77, 124, 125
-
Match options
- bit-mask: string
-
Enter bit mask pattern string
- vrf: string
-
Specify match VRF
- enable: null
-
Enable Create or enter server profile class. Deletion of this object also causes deletion of all associated objects under Class.
- subnet-mask: string
-
Configure Subnet Mask
- boot-filename: string
-
Boot Filename
- class-name: string
-
class name
- domain-name: string
-
Domain name
- netbios-node-type: object
-
NetBIOS node type
-
- hybrid-node: string
-
Set string
- mixed-node: string
-
Set string
- hexadecimal: string
-
Hexadecimal number
- broadcast-node: string
-
Set string
- peer-to-peer-node: string
-
Set string
- next-server: string
-
Configure the tftp-server IP to be used by the client
- dns-servers: object
-
DNS servers
-
- dns-server: string[]
-
string DNS Server's IP address
- net-bios-name-servers: object
-
NetBIOS name servers
-
- net-bios-name-server: string[]
-
string NetBIOSNameServer's IP address
- pool: string
-
Specify the pool
- lease: object
-
lease
-
- infinite: string
-
Set string
- hours: integer
-
Hours
range:"0..23" units:"hour" - minutes: integer
-
Minutes
range:"1..59" units:"minute" - days: integer
-
Days
range:"0..365" units:"day"
Example
{
"subnet-mask": "string",
"dhcp-to-aaa": {
"option": {
"list": {
"option-number": "integer",
"option-all": "integer"
}
}
},
"domain-name": "string",
"boot-filename": "string",
"next-server": "string",
"dns-servers": {
"dns-server": [ "string" ]
},
"server-id-check": {
"check": [ null ]
},
"match": {
"option-defaults": {
"option-default": [
{
"matchaction": "string",
"matchoption": "string"
}
]
},
"options": {
"option": [
{
"pattern": "string",
"matchaction": "string",
"matchoption": "string",
"format": "integer"
}
]
}
},
"lease": {
"infinite": "string",
"hours": "integer",
"minutes": "integer",
"days": "integer"
},
"server-allow-move": [ null ],
"lease-limit": {
"range": "integer",
"lease-limit-value": "string"
},
"secure-arp": [ null ],
"relay": {
"authenticate": "integer"
},
"enable": [ null ],
"broadcast-flag": {
"policy": "string"
},
"net-bios-name-servers": {
"net-bios-name-server": [ "string" ]
},
"pool": "string",
"session": {
"throttle-type": {
"mac-throttle": {
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"default-routers": {
"default-router": [ "string" ]
},
"netbios-node-type": {
"hybrid-node": "string",
"mixed-node": "string",
"hexadecimal": "string",
"broadcast-node": "string",
"peer-to-peer-node": "string"
},
"aaa-server": {
"dhcp-option": {
"force-insert": [ null ]
}
},
"requested-ip-address": {
"check": [ null ]
},
"classes": {
"class": [
{
"default-routers": {
"default-router": [ "string" ]
},
"class-match": {
"l2-interface": "string",
"class-options": {}
},
"option-codes": {
"option-code": [
{
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
]
}
}
]
},
"option-codes": {
"option-code": [
{
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
]
}
}
server-id-check_schema:
Validate server ID check
- check: null
-
specify server-id-check disable
Example
{
"check": [ null ]
}
lease-limit_schema:
Specify limit lease
- range: integer
-
Value of limit lease count in Decimal
range:"1..240000" - lease-limit-value: string per-interface, per-circuit-id, per-remote-id
-
Configure Lease limit value
Example
{
"range": "integer",
"lease-limit-value": "string"
}
requested-ip-address_schema:
Validate Requested IP Address
- check: null
-
specify requested-ip-address-check disable
Example
{
"check": [ null ]
}
aaa-server_schema:
Enable aaa dhcp option force-insert
- dhcp-option: object
-
Enable aaa dhcp option force-insert
-
- force-insert: null
-
Enable aaa dhcp option force-insert
Example
{
"dhcp-option": {
"force-insert": [ null ]
}
}
dhcp-option_schema:
Enable aaa dhcp option force-insert
- force-insert: null
-
Enable aaa dhcp option force-insert
Example
{
"force-insert": [ null ]
}
default-routers_schema:
default routers
- default-router: string[]
-
string Router's IP address
Example
{
"default-router": [ "string" ]
}
net-bios-name-servers_schema:
NetBIOS name servers
- net-bios-name-server: string[]
-
string NetBIOSNameServer's IP address
Example
{
"net-bios-name-server": [ "string" ]
}
option-defaults_schema:
Table of OptionDefault
- option-default: object[]
-
Specify match option
-
object - matchaction: string allow, drop
-
Vendor action
- matchoption: string circuitid, remoteid, 60, 77, 124, 125
-
Match option 60
Example
{
"option-default": [
{
"matchaction": "string",
"matchoption": "string"
}
]
}
option-default_schema:
- matchaction: string allow, drop
-
Vendor action
- matchoption: string circuitid, remoteid, 60, 77, 124, 125
-
Match option 60
Example
{
"matchaction": "string",
"matchoption": "string"
}
broadcast-flag_schema:
Specify broadcast flag
- policy: string ignore, check, unicast-always
-
Broadcast flag policy
Example
{
"policy": "string"
}
session_schema:
Change sessions configuration
- throttle-type: object
-
Throttle DHCP sessions based on MAC address
-
- mac-throttle: object
-
Throttle DHCP sessions from any one MAC address
-
- num-discover: integer
-
Number of discovers at which to throttle
range:"0..1000" default:"100" - num-block: integer
-
Throttle blocking period (in secs)
range:"1..100" units:"second" - num-request: integer
-
Throttle request period (in secs)
range:"1..100" units:"second"
Example
{
"throttle-type": {
"mac-throttle": {
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
}
throttle-type_schema:
Throttle DHCP sessions based on MAC address
- mac-throttle: object
-
Throttle DHCP sessions from any one MAC address
-
- num-discover: integer
-
Number of discovers at which to throttle
range:"0..1000" default:"100" - num-block: integer
-
Throttle blocking period (in secs)
range:"1..100" units:"second" - num-request: integer
-
Throttle request period (in secs)
range:"1..100" units:"second"
Example
{
"mac-throttle": {
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
mac-throttle_schema:
Throttle DHCP sessions from any one MAC address
- num-discover: integer
-
Number of discovers at which to throttle
range:"0..1000" default:"100" - num-block: integer
-
Throttle blocking period (in secs)
range:"1..100" units:"second" - num-request: integer
-
Throttle request period (in secs)
range:"1..100" units:"second"
Example
{
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
classes_schema:
DHCP class table
- class: object[]
-
DHCP class
-
object - enable: null
-
Enable the DHCP IPV4 proxy class
- vrfs: object
-
List of VRFs
-
- vrf: object[]
-
VRF name
-
object - vrf-name: string
-
VRF name
- helper-addresses: object
-
Helper addresses
-
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
- class-name: string
-
Class name
- match: object
-
Match option
-
- option: object
-
Match option
-
- pattern: string
-
Hex pattern string
- bit-mask: string
-
Bit mask pattern
- option-type: string 60/60, 77/77, 124/124, 125/125
-
Match option
- vrf: string
-
Match VRF name
Example
{
"class": [
{
"enable": [ null ],
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"helper-addresses": {
"helper-address": [
{
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string",
"match": {
"option": {
"pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
}
class_schema:
- enable: null
-
Enable the DHCP IPV4 proxy class
- vrfs: object
-
List of VRFs
-
- vrf: object[]
-
VRF name
-
object - vrf-name: string
-
VRF name
- helper-addresses: object
-
Helper addresses
-
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
- class-name: string
-
Class name
- match: object
-
Match option
-
- option: object
-
Match option
-
- pattern: string
-
Hex pattern string
- bit-mask: string
-
Bit mask pattern
- option-type: string 60/60, 77/77, 124/124, 125/125
-
Match option
- vrf: string
-
Match VRF name
Example
{
"enable": [ null ],
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"helper-addresses": {
"helper-address": [
{
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string",
"match": {
"option": {
"pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
class-match_schema:
Insert match keyword
- l2-interface: string
-
Specify match l2-interface
- class-options: object
-
Table of Class-Option
-
- class-option: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchoption: string circuitid, remoteid, 60, 77, 124, 125
-
Match options
- bit-mask: string
-
Enter bit mask pattern string
- vrf: string
-
Specify match VRF
Example
{
"l2-interface": "string",
"class-options": {
"class-option": [
{
"pattern": "string",
"matchoption": "string",
"bit-mask": "string"
}
]
},
"vrf": "string"
}
class-options_schema:
Table of Class-Option
- class-option: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchoption: string circuitid, remoteid, 60, 77, 124, 125
-
Match options
- bit-mask: string
-
Enter bit mask pattern string
Example
{
"class-option": [
{
"pattern": "string",
"matchoption": "string",
"bit-mask": "string"
}
]
}
class-option_schema:
- pattern: string
-
Enter hex pattern string
- matchoption: string circuitid, remoteid, 60, 77, 124, 125
-
Match options
- bit-mask: string
-
Enter bit mask pattern string
Example
{
"pattern": "string",
"matchoption": "string",
"bit-mask": "string"
}
lease_schema:
lease
- infinite: string
-
Set string
- hours: integer
-
Hours
range:"0..23" units:"hour" - minutes: integer
-
Minutes
range:"1..59" units:"minute" - days: integer
-
Days
range:"0..365" units:"day"
Example
{
"infinite": "string",
"hours": "integer",
"minutes": "integer",
"days": "integer"
}
netbios-node-type_schema:
NetBIOS node type
- hybrid-node: string
-
Set string
- mixed-node: string
-
Set string
- hexadecimal: string
-
Hexadecimal number
- broadcast-node: string
-
Set string
- peer-to-peer-node: string
-
Set string
Example
{
"hybrid-node": "string",
"mixed-node": "string",
"hexadecimal": "string",
"broadcast-node": "string",
"peer-to-peer-node": "string"
}
dns-servers_schema:
DNS servers
- dns-server: string[]
-
string DNS Server's IP address
Example
{
"dns-server": [ "string" ]
}
option-codes_schema:
Table of OptionCode
- option-code: object[]
-
DHCP option code
-
object - option-code: integer
-
DHCP option code
range:"0..255" - hex-string: string
-
Hexadecimal string
- ascii-string: string
-
ASCII string
- ip-address: string[]
-
string Server's IP address
- force-insert: integer
-
Set constant integer
Example
{
"option-code": [
{
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
]
}
option-code_schema:
- option-code: integer
-
DHCP option code
range:"0..255" - hex-string: string
-
Hexadecimal string
- ascii-string: string
-
ASCII string
- ip-address: string[]
-
string Server's IP address
- force-insert: integer
-
Set constant integer
Example
{
"option-code": "integer",
"hex-string": "string",
"ascii-string": "string",
"ip-address": [ "string" ],
"force-insert": "integer"
}
relay_schema:
DHCP Relay profile
- gi-addr-policy: object
-
GIADDR policy
-
- policy: string giaddr-policy-keep
-
GIADDR policy
- broadcast-policy: object
-
Broadcast Flag policy
-
- policy: string ignore, check, unicast-always
-
Broadcast flag policy
- mac-mismatch-action: string forward, drop
-
Action to take if L2 header source Mac and dhcp header mac address don't match
- relay-information-option: object
-
Relay agent information option
-
- insert: null
-
Insert Relay Agent Information circuit ID and remote ID suboptions in client requests
- subscriber-id: string
-
Subscriber ID
- vpn-mode: string rfc, cisco
-
VPN Mode
- allow-untrusted: null
-
Forward untrusted packets
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- vpn: null
-
Insert VPN options
- check: null
-
Check Relay Agent Information Option in server reply
- vrfs: object
-
VRF Helper Addresses
-
- vrf: object[]
-
VRF Name
-
object - vrf-name: string
-
VRF Name
- helper-addresses: object
-
Helper Addresses
-
- helper-address: object[]
-
Helper Address
-
object - gateway-address: string
-
GatewayAddress
- enable: null
-
Enable helper - deprecated
- ip-address: string
-
IPV4 Address
Example
{
"gi-addr-policy": {
"policy": "string"
},
"broadcast-policy": {
"policy": "string"
},
"mac-mismatch-action": "string",
"relay-information-option": {
"insert": [ null ],
"subscriber-id": "string",
"vpn-mode": "string",
"allow-untrusted": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
},
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"helper-addresses": {
"helper-address": [
{
"gateway-address": "string",
"enable": [ null ],
"ip-address": "string"
}
]
}
}
]
}
}
dhcp-to-aaa_schema:
Enable to provide the list of options need to send to aaa
- option: object
-
option type
-
- list: object
-
List of options
-
- option: integer[]
-
integer List of options
range:"1..255" - option-all: integer
-
option all
Example
{
"option": {
"list": {
"option": [ "integer" ],
"option-all": "integer"
}
}
}
list_schema:
List of options
- option: integer[]
-
integer List of options
range:"1..255" - option-all: integer
-
option all
Example
{
"option": [ "integer" ],
"option-all": "integer"
}
gi-addr-policy_schema:
GIADDR policy
- policy: string giaddr-policy-keep
-
GIADDR policy
Example
{
"policy": "string"
}
helper-addresses_schema:
Helper addresses
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
Example
{
"helper-address": [
{
"server-address": "string",
"gateway-address": "string"
}
]
}
helper-address_schema:
- server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
Example
{
"server-address": "string",
"gateway-address": "string"
}
broadcast-policy_schema:
Broadcast Flag policy
- policy: string ignore, check, unicast-always
-
Broadcast flag policy
Example
{
"policy": "string"
}
proxy_schema:
DHCP proxy profile
- proxy-allow-move: null
-
Allow dhcp subscriber move
- limit-lease: object
-
Proxy limit lease
-
- limit-lease-count: string
-
Limit lease count
- limit-type: string interface, circuit-id, remote-id, circuit-id-remote-id
-
Lease limit type
- secure-arp: null
-
DHCP IPV4 profile proxy secure-arp enable
- sessions: object
-
Change sessions configuration
-
- proxy-throttle-type: object
-
Throttle DHCP sessions based on MAC address
-
- proxy-mac-throttle: object
-
Throttle DHCP sessions from any one MAC address
-
- num-discover: integer
-
Number of discovers at which to throttle
range:"0..1000" default:"100" - num-block: integer
-
Throttle blocking period (in secs)
range:"1..100" units:"second" - num-request: integer
-
Throttle request period (in secs)
range:"1..100" units:"second"
- delayed-authen-proxy: null
-
For BNG session, delay the authentication
- auth-username: object
-
Authentication Username formating
-
- arg1: string auth-username-mac, auth-username-giaddr
-
Username Formatting first argument
- arg2: string auth-username-mac, auth-username-giaddr
-
Username Formatting second argument
- giaddr: object
-
Specify gateway address policy
-
- policy: string giaddr-policy-keep
-
Gateway address policy
- lease-proxy: object
-
DHCPv4 lease proxy
-
- set-server-options: null
-
Set DHCP server sent options in lease proxy generating ACK
- client-lease-time: integer
-
Specify client lease proxy time
range:"300..4294967295"
- classes: object
-
DHCP class table
-
- class: object[]
-
DHCP class
-
object - enable: null
-
Enable the DHCP IPV4 proxy class
- vrfs: object
-
List of VRFs
-
- vrf: object[]
-
VRF name
-
object - vrf-name: string
-
VRF name
- helper-addresses: object
-
Helper addresses
-
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
- class-name: string
-
Class name
- match: object
-
Match option
-
- option: object
-
Match option
-
- pattern: string
-
Hex pattern string
- bit-mask: string
-
Bit mask pattern
- option-type: string 60/60, 77/77, 124/124, 125/125
-
Match option
- vrf: string
-
Match VRF name
- vrfs: object
-
List of VRFs
-
- vrf: object[]
-
VRF name
-
object - vrf-name: string
-
VRF name
- helper-addresses: object
-
Helper addresses
-
- helper-address: object[]
-
Helper address
-
object - server-address: string
-
IPv4 address
- gateway-address: string
-
Gateway address
- enable: null
-
DHCP IPV4 profile mode enable
- broadcast-flag: object
-
Specify broadcast flag
-
- policy: string ignore, check, unicast-always
-
Broadcast flag policy
- dhcp-to-aaa: object
-
Enable to provide the list of options need to send to aaa
-
- option: object
-
option type
-
- list: object
-
List of options
-
- option: integer[]
-
integer List of options
range:"1..255" - option-all: integer
-
option all
- match: object
-
Insert match keyword
-
- option-filters: object
-
Table of Option
-
- option-filter: object[]
-
Specify match option
-
object - pattern: string
-
Enter hex pattern string
- matchaction: string allow, drop, relay
-
Vendor action
- matchoption: integer
-
Match option 60
- format: integer
-
Set constant integer
- def-options: object
-
Table of Option
-
- def-option: object[]
-
Specify match option
-
object - def-matchaction: string allow, drop, relay
-
Vendor action
- def-matchoption: integer
-
Match option 60
- relay-information: object
-
Relay agent information option
-
- authenticate: string received, inserted
-
Relay information option authenticate
- option: null
-
Insert relay rgent information circuit ID and remote ID suboptions in client requests
- remote-id-xr: null
-
Insert Remote-id sub-option
- allow-untrusted: null
-
Forward untrusted packets
- remote-id-suppress: null
-
Suppress Remote ID
- vpn-mode: string rfc, cisco
-
VPN Mode
- remote-id: string
-
Remote ID
- circuit-id: null
-
Insert Circuit-id sub-option
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- vpn: null
-
Insert VPN options
- check: null
-
Check relay agent information option in server reply
Example
{
"proxy-allow-move": [ null ],
"limit-lease": {
"limit-lease-count": "string",
"limit-type": "string"
},
"secure-arp": [ null ],
"sessions": {
"proxy-throttle-type": {
"proxy-mac-throttle": {
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
},
"delayed-authen-proxy": [ null ],
"auth-username": {
"arg1": "string",
"arg2": "string"
},
"giaddr": {
"policy": "string"
},
"lease-proxy": {
"set-server-options": [ null ],
"client-lease-time": "integer"
},
"classes": {
"class": [
{
"enable": [ null ],
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"helper-addresses": {
"helper-address": [
{
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"class-name": "string",
"match": {
"option": {
"pattern": "string",
"bit-mask": "string",
"option-type": "string"
},
"vrf": "string"
}
}
]
},
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"helper-addresses": {
"helper-address": [
{
"server-address": "string",
"gateway-address": "string"
}
]
}
}
]
},
"enable": [ null ],
"broadcast-flag": {
"policy": "string"
},
"dhcp-to-aaa": {
"option": {
"list": {
"option": [ "integer" ],
"option-all": "integer"
}
}
},
"match": {
"option-filters": {
"option-filter": [
{
"pattern": "string",
"matchaction": "string",
"matchoption": "integer",
"format": "integer"
}
]
},
"def-options": {
"def-option": [
{
"def-matchaction": "string",
"def-matchoption": "integer"
}
]
}
},
"relay-information": {
"authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
}
giaddr_schema:
Specify gateway address policy
- policy: string giaddr-policy-keep
-
Gateway address policy
Example
{
"policy": "string"
}
auth-username_schema:
Authentication Username formating
- arg1: string auth-username-mac, auth-username-giaddr
-
Username Formatting first argument
- arg2: string auth-username-mac, auth-username-giaddr
-
Username Formatting second argument
Example
{
"arg1": "string",
"arg2": "string"
}
relay-information_schema:
Relay agent information option
- authenticate: string received, inserted
-
Relay information option authenticate
- option: null
-
Insert relay rgent information circuit ID and remote ID suboptions in client requests
- remote-id-xr: null
-
Insert Remote-id sub-option
- allow-untrusted: null
-
Forward untrusted packets
- remote-id-suppress: null
-
Suppress Remote ID
- vpn-mode: string rfc, cisco
-
VPN Mode
- remote-id: string
-
Remote ID
- circuit-id: null
-
Insert Circuit-id sub-option
- policy: string replace, keep, drop, encapsulate
-
Relay information option policy
- vpn: null
-
Insert VPN options
- check: null
-
Check relay agent information option in server reply
Example
{
"authenticate": "string",
"option": [ null ],
"remote-id-xr": [ null ],
"allow-untrusted": [ null ],
"remote-id-suppress": [ null ],
"vpn-mode": "string",
"remote-id": "string",
"circuit-id": [ null ],
"policy": "string",
"vpn": [ null ],
"check": [ null ]
}
sessions_schema:
Change sessions configuration
- proxy-throttle-type: object
-
Throttle DHCP sessions based on MAC address
-
- proxy-mac-throttle: object
-
Throttle DHCP sessions from any one MAC address
-
- num-discover: integer
-
Number of discovers at which to throttle
range:"0..1000" default:"100" - num-block: integer
-
Throttle blocking period (in secs)
range:"1..100" units:"second" - num-request: integer
-
Throttle request period (in secs)
range:"1..100" units:"second"
Example
{
"proxy-throttle-type": {
"proxy-mac-throttle": {
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
}
proxy-throttle-type_schema:
Throttle DHCP sessions based on MAC address
- proxy-mac-throttle: object
-
Throttle DHCP sessions from any one MAC address
-
- num-discover: integer
-
Number of discovers at which to throttle
range:"0..1000" default:"100" - num-block: integer
-
Throttle blocking period (in secs)
range:"1..100" units:"second" - num-request: integer
-
Throttle request period (in secs)
range:"1..100" units:"second"
Example
{
"proxy-mac-throttle": {
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
}
proxy-mac-throttle_schema:
Throttle DHCP sessions from any one MAC address
- num-discover: integer
-
Number of discovers at which to throttle
range:"0..1000" default:"100" - num-block: integer
-
Throttle blocking period (in secs)
range:"1..100" units:"second" - num-request: integer
-
Throttle request period (in secs)
range:"1..100" units:"second"
Example
{
"num-discover": "integer",
"num-block": "integer",
"num-request": "integer"
}
limit-lease_schema:
Proxy limit lease
- limit-lease-count: string
-
Limit lease count
- limit-type: string interface, circuit-id, remote-id, circuit-id-remote-id
-
Lease limit type
Example
{
"limit-lease-count": "string",
"limit-type": "string"
}
lease-proxy_schema:
DHCPv4 lease proxy
- set-server-options: null
-
Set DHCP server sent options in lease proxy generating ACK
- client-lease-time: integer
-
Specify client lease proxy time
range:"300..4294967295"
Example
{
"set-server-options": [ null ],
"client-lease-time": "integer"
}
database_schema:
Enable DHCP binding database storage to file system
- full-write-interval: integer
-
Full file write interval (default 10 minutes)
range:"1..1440" default:10 minutes)" - incremental-write-interval: integer
-
Incremental file write interval (default 1 minutes)
range:"1..1440" default:"1" - proxy: null
-
Enable DHCP proxy binding database storage to file system
- snoop: null
-
Enable DHCP snoop binding database storage to file system
- server: null
-
Enable DHCP server binding database storage to file system
Example
{
"full-write-interval": "integer",
"incremental-write-interval": "integer",
"proxy": [ null ],
"snoop": [ null ],
"server": [ null ]
}
interfaces_schema:
DHCP IPV4 Interface Table
- interface: object[]
-
DHCP IPV4 Interface
-
object - profile: object
-
Profile name and mode
-
- profile-name: string
-
Profile name
- mode: string base, relay, snoop, server, proxy, base2
-
DHCP mode
- interface-name: string
-
Interface Name
- base-interface: object
-
DHCP IPv4 Base profile information
-
- profile: string
-
Interface profile name
- base-dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- proxy-interface: object
-
DHCP IPv4 proxy information
-
- profile: string
-
Interface profile name
- dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- static-mode: object
-
Static Table Entries containing MAC address to IP address bindings
-
- statics: object
-
Static Table Entries containing MAC address to IP address bindings
-
- static: object[]
-
DHCP static binding of Mac address to IP address
-
object - client-id: string
-
Client Id
- layer: string layer2, layer3
-
DHCP IPV4 Static layer
- static-address: string
-
IP address
- mac-address: string
-
MACAddress
- server-interface: object
-
DHCP IPv4 Server information
-
- profile: string
-
Interface profile name
- server-dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- relay-interface: object
-
DHCP IPv4 relay information
-
- relay-dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- snoop-interface: object
-
DHCP IPv4 snoop information
-
- snoop-circuit-id: object
-
Configure circuit ID for snoop 1. Hex 2. ASCII
-
- format-type: integer
-
Format type, 1. Hex 2. ASCII
range:"1..2" - circuit-id-value: string
-
Enter circuit-id value
Example
{
"interface": [
{
"profile": {
"profile-name": "string",
"mode": "string"
},
"interface-name": "string",
"base-interface": {
"profile": "string",
"base-dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
},
"proxy-interface": {
"profile": "string",
"dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
},
"static-mode": {
"statics": {
"static": [
{
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
]
}
},
"server-interface": {
"profile": "string",
"server-dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
},
"relay-interface": {
"relay-dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
},
"snoop-interface": {
"snoop-circuit-id": {}
}
}
]
}
interface_schema:
- profile: object
-
Profile name and mode
-
- profile-name: string
-
Profile name
- mode: string base, relay, snoop, server, proxy, base2
-
DHCP mode
- interface-name: string
-
Interface Name
- base-interface: object
-
DHCP IPv4 Base profile information
-
- profile: string
-
Interface profile name
- base-dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- proxy-interface: object
-
DHCP IPv4 proxy information
-
- profile: string
-
Interface profile name
- dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- static-mode: object
-
Static Table Entries containing MAC address to IP address bindings
-
- statics: object
-
Static Table Entries containing MAC address to IP address bindings
-
- static: object[]
-
DHCP static binding of Mac address to IP address
-
object - client-id: string
-
Client Id
- layer: string layer2, layer3
-
DHCP IPV4 Static layer
- static-address: string
-
IP address
- mac-address: string
-
MACAddress
- server-interface: object
-
DHCP IPv4 Server information
-
- profile: string
-
Interface profile name
- server-dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- relay-interface: object
-
DHCP IPv4 relay information
-
- relay-dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- snoop-interface: object
-
DHCP IPv4 snoop information
-
- snoop-circuit-id: object
-
Configure circuit ID for snoop 1. Hex 2. ASCII
-
- format-type: integer
-
Format type, 1. Hex 2. ASCII
range:"1..2" - circuit-id-value: string
-
Enter circuit-id value
Example
{
"profile": {
"profile-name": "string",
"mode": "string"
},
"interface-name": "string",
"base-interface": {
"profile": "string",
"base-dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
},
"proxy-interface": {
"profile": "string",
"dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
},
"static-mode": {
"statics": {
"static": [
{
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
]
}
},
"server-interface": {
"profile": "string",
"server-dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
},
"relay-interface": {
"relay-dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
},
"snoop-interface": {
"snoop-circuit-id": {
"format-type": "integer",
"circuit-id-value": "string"
}
}
}
proxy-interface_schema:
DHCP IPv4 proxy information
- profile: string
-
Interface profile name
- dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
Example
{
"profile": "string",
"dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
dhcp-circuit-id_schema:
Circuit ID value
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
Example
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
base-interface_schema:
DHCP IPv4 Base profile information
- profile: string
-
Interface profile name
- base-dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
Example
{
"profile": "string",
"base-dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
base-dhcp-circuit-id_schema:
Circuit ID value
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
Example
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
relay-interface_schema:
DHCP IPv4 relay information
- relay-dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
Example
{
"relay-dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
relay-dhcp-circuit-id_schema:
Circuit ID value
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
Example
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
static-mode_schema:
Static Table Entries containing MAC address to IP address bindings
- statics: object
-
Static Table Entries containing MAC address to IP address bindings
-
- static: object[]
-
DHCP static binding of Mac address to IP address
-
object - client-id: string
-
Client Id
- layer: string layer2, layer3
-
DHCP IPV4 Static layer
- static-address: string
-
IP address
- mac-address: string
-
MACAddress
Example
{
"statics": {
"static": [
{
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
]
}
}
statics_schema:
Static Table Entries containing MAC address to IP address bindings
- static: object[]
-
DHCP static binding of Mac address to IP address
-
object - client-id: string
-
Client Id
- layer: string layer2, layer3
-
DHCP IPV4 Static layer
- static-address: string
-
IP address
- mac-address: string
-
MACAddress
Example
{
"static": [
{
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
]
}
static_schema:
- client-id: string
-
Client Id
- layer: string layer2, layer3
-
DHCP IPV4 Static layer
- static-address: string
-
IP address
- mac-address: string
-
MACAddress
Example
{
"client-id": "string",
"layer": "string",
"static-address": "string",
"mac-address": "string"
}
server-interface_schema:
DHCP IPv4 Server information
- profile: string
-
Interface profile name
- server-dhcp-circuit-id: object
-
Circuit ID value
-
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
Example
{
"profile": "string",
"server-dhcp-circuit-id": {
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
}
server-dhcp-circuit-id_schema:
Circuit ID value
- argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- format: string no-format, format
-
Format String
- circuit-id: string
-
DHCP IPv4 circuit ID value
- argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
- argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface
-
Argument
Example
{
"argument10": "string",
"argument11": "string",
"argument12": "string",
"argument13": "string",
"argument14": "string",
"argument15": "string",
"argument16": "string",
"format": "string",
"circuit-id": "string",
"argument6": "string",
"argument7": "string",
"argument4": "string",
"argument5": "string",
"argument2": "string",
"argument3": "string",
"argument1": "string",
"argument8": "string",
"argument9": "string"
}
snoop-interface_schema:
DHCP IPv4 snoop information
- snoop-circuit-id: object
-
Configure circuit ID for snoop 1. Hex 2. ASCII
-
- format-type: integer
-
Format type, 1. Hex 2. ASCII
range:"1..2" - circuit-id-value: string
-
Enter circuit-id value
Example
{
"snoop-circuit-id": {
"format-type": "integer",
"circuit-id-value": "string"
}
}
snoop-circuit-id_schema:
Configure circuit ID for snoop 1. Hex 2. ASCII
- format-type: integer
-
Format type, 1. Hex 2. ASCII
range:"1..2" - circuit-id-value: string
-
Enter circuit-id value
Example
{
"format-type": "integer",
"circuit-id-value": "string"
}
duplicate-mac-allowed_schema:
Allow Duplicate MAC Address
- duplicate-mac: null
-
Duplicate mac is allowed
- exclude-vlan: null
-
Exclude vlan
- include-giaddr: null
-
Include giaddr
Example
{
"duplicate-mac": [ null ],
"exclude-vlan": [ null ],
"include-giaddr": [ null ]
}
rate-limit_schema:
Rate limit ingress packets
- num-period: integer
-
Rate limiter period in msec (default: 200 msec)
range:"1..1000" default:"200" - num-discover: integer
-
Max DISCOVER packets per rate-limiter period (default 100)
range:"0..1000" default:"100"
Example
{
"num-period": "integer",
"num-discover": "integer"
}